Update an order

PATCH

/orders/{id}

curl --request PATCH \
  --url https://acme.mykreezalid.com/api/v1/orders/1 \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "accepted", "fulfillment_status": "started" }'

• Your marketplace's address. A marketplace with a custom domain must be called on that domain instead (https://developers.kreezalid.com/getting-started/base-urls/).

Updates the fields you send and leaves the others unchanged. You may also send them wrapped in an order key. No notification is sent: see Notifications. Check success in the response.

Authorizations

• basic

Parameters

Path Parameters

id

required

integer

Order’s unique identifier

Request Body^required

Media typeapplication/json

object

status

string

Allowed values: draft pending new accepted service_provided shipped customer_confirmed supplier_confirmed declined completed failed canceled

fulfillment_status

string

nullable

Allowed values: started scheduled prepared shipped in_transit available delivered executed canceled error

refusal_reason

Why the order was declined

string

tracking_number

string

order_items

Changes to items of the order, each named by its id; items is accepted too. Only the last entry of the list is applied, so send one item per request. Items of other orders are ignored.

Array<object>

object

id

required

Identifier of the order item

integer

status

string

refusal_reason

string

Example

{
  "status": "accepted",
  "fulfillment_status": "started"
}

Responses

200

Whether the order has been updated

Media typeapplication/json

object

success

boolean

message

Order updated, or Error. No update. when nothing was saved

string

Example

{
  "success": true,
  "message": "Order updated"
}

404

No order has this identifier, or status or fulfillment_status is not one of the values listed.