Custom order status - API
This is the call for handling the orders status. This can be used for all sorts of information regarding an order. A state or text can be linked to a specific order.
With this info an order state can be shown to the customer or a timeline with all different states.
The definition of StateId’s can be determined by the customer itself. If special handling is needed in the frontend with this state, please inform CloudSuite.
URL
/proxy/v1/orderstatus/?shop=xMethod
POST
Parameter
shop=1
Parameters are customer specific.
Fields
Field | Type | Required | Description | Remarks |
|---|---|---|---|---|
CloudsuiteOrderId | string | yes* | CloudSuite order number (reference) | |
orderId | string | yes* | ERP order ID | |
state | string | yes | The state of the order | |
dateTime | date-time | yes | The date / time of the update | |
stateId | string | no | The ID of the status | |
state | object | yes | ||
state- lang | string | yes | The language of the text provided (ISO code of language/Country f.e. nl_NL). | |
state- value | string | yes | The text which belongs to this status | This text will be placed in a new field in the order-header. |
Body
Result
Related content
© 2024 CloudSuite BV, All rights reserved