orderUpdate

Updates an existing order's fields.

• DRAFT orders: updates are applied immediately and synchronously.
• OPENED orders: updates are processed asynchronously. The request may be rejected if warehouse production has already started for one or more lines.

Required scope: edit_orders

---

Mutation

mutation OrderUpdate($input: OrderInput!) {
  orderUpdate(input: $input) {
    id
    type
    state
    message
  }
}

The return type is a DispatchableRequest. For DRAFT orders, the state will reflect the update result immediately. For OPENED orders, monitor webhooks for the asynchronous outcome.

---

Input: OrderInput

The same OrderInput type used in orderCreate. Provide the id field (or externalReference) to target the order to update, and set only the fields you want to change.

Field	Type	Required	Description
id	String	✅*	Internal order UUID — required unless using externalReference
organizationId	String	❌	Organization UUID
externalReference	String	❌*	Used as lookup key if id is not provided
invoiceNumber	String	❌	Invoice number
type	OrderTypeEnum	❌	B2C or B2B
dispatchingType	OrderDispatchingTypeEnum	❌	AUTOMATIC or MANUAL
priority	PriorityEnum	❌	LOW, NORMAL, or HIGH
inventoryPolicy	InventoryPolicyEnum	❌	DENY, ALLOW, SKIP, or ADJUST
total	Float	❌	Order total excluding tax
totalTaxInclusive	Float	❌	Order total including tax
totalShipping	Float	❌	Shipping cost
currency	String	❌	ISO 4217 currency code
issuedAt	DateTime	❌	Order issue date
delivery	DeliveryInput	❌	Updated delivery address and contact
lines	[OrderLineInput!]	❌	Updated order lines
comment	String	❌	Order comment

*You must provide either id or externalReference to identify the order.

---

Example Variables

{
  "input": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "priority": "HIGH",
    "comment": "Urgent — customer VIP",
    "delivery": {
      "type": "PERSON",
      "fullname": "Jane Doe",
      "email": "jane.doe@example.com",
      "address": "456 Rue de Rivoli",
      "zipcode": "75004",
      "city": "Paris",
      "country": "FR",
      "phone": "+33698765432"
    }
  }
}

---

Example Response

{
  "data": {
    "orderUpdate": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "ORDER_UPDATE",
      "state": "ACCEPTED",
      "message": "Order updated successfully"
    }
  }
}

---

Code Examples

curl

curl -X POST https://api-v3.happycolis.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "query": "mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { id type state message } }",
    "variables": {
      "input": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "priority": "HIGH",
        "comment": "Urgent — customer VIP"
      }
    }
  }'

Node.js

const mutation = `
  mutation OrderUpdate($input: OrderInput!) {
    orderUpdate(input: $input) {
      id
      type
      state
      message
    }
  }
`;

const response = await fetch('https://api-v3.happycolis.com/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
  body: JSON.stringify({
    query: mutation,
    variables: {
      input: {
        id: '550e8400-e29b-41d4-a716-446655440000',
        priority: 'HIGH',
        comment: 'Urgent — customer VIP',
      },
    },
  }),
});

const { data } = await response.json();
console.log(data.orderUpdate);

Python

import os
import requests

mutation = """
mutation OrderUpdate($input: OrderInput!) {
  orderUpdate(input: $input) {
    id
    type
    state
    message
  }
}
"""

response = requests.post(
    'https://api-v3.happycolis.com/graphql',
    headers={'Authorization': f'Bearer {os.environ["ACCESS_TOKEN"]}'},
    json={
        'query': mutation,
        'variables': {
            'input': {
                'id': '550e8400-e29b-41d4-a716-446655440000',
                'priority': 'HIGH',
                'comment': 'Urgent — customer VIP',
            }
        },
    },
)

data = response.json()['data']
print(data['orderUpdate'])

PHP

<?php
$mutation = <<<'GQL'
mutation OrderUpdate($input: OrderInput!) {
  orderUpdate(input: $input) {
    id
    type
    state
    message
  }
}
GQL;

$ch = curl_init('https://api-v3.happycolis.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode([
        'query'     => $mutation,
        'variables' => [
            'input' => [
                'id'       => '550e8400-e29b-41d4-a716-446655440000',
                'priority' => 'HIGH',
                'comment'  => 'Urgent — customer VIP',
            ],
        ],
    ]),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'Authorization: Bearer ' . getenv('ACCESS_TOKEN'),
    ],
]);

$result = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($result['data']['orderUpdate']);

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	mutation := `
		mutation OrderUpdate($input: OrderInput!) {
			orderUpdate(input: $input) {
				id
				type
				state
				message
			}
		}`

	body, _ := json.Marshal(map[string]any{
		"query": mutation,
		"variables": map[string]any{
			"input": map[string]any{
				"id":       "550e8400-e29b-41d4-a716-446655440000",
				"priority": "HIGH",
				"comment":  "Urgent — customer VIP",
			},
		},
	})

	req, _ := http.NewRequest("POST", "https://api-v3.happycolis.com/graphql", bytes.NewBuffer(body))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"))

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]any
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result["data"])
}