API ReferenceSim Order Management

Update order fields

Parent organisations can use this call to update shipping information, dates and status of their child organisation’s orders.

When the order status is set to Shipped, and no shipped_date is given or stored in the order, the current time is patched. The same goes for status Delivered.

This call will write a Order Updated event with the changes.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

order_iddoubleRequired
Numerical ID of an order

Request

This endpoint expects an object.
paidbooleanOptional
statusobjectOptional
shipped_datestringOptionalformat: "date-time"
delivered_datestringOptionalformat: "date-time"
external_payment_referencestringOptional
external_shipping_referencestringOptional
shipped_withobjectOptional
variantlist of objectsOptional
force_auto_provisioningbooleanOptional

If set to true, the order will be auto-provisioned even if the auto_provisioning field of the order is set to false.

Response

Successful

Errors