Support Portal

Welcome
Login

2.1. Add order states

This endpoint allows you to update the state of an order based on your internal workflow.

Methods

POST order_states

Parameters

ParameterMandatoryTypeExampleDescription
shop_order_id
yes
string"123456789"The order reference inside your system
state
yes
string | choice"paid"The current state of the order. See the list of possible options below
datetime
yes
datetime"2021-05-15T16:53:07+01:00"Timestamp when the order changed to this status inside your system
location
no
string"Schwedter strasse 36A 10435 Berlin"The physical location of the order

States available

StateDescription
newThe initial state of an order. It is set automatically on order creation.
paid
shippedThe state is assigned automatically when the first shipment for the order gets created.
in_productionA state representing the status of the order in your warehouse.
in_preparationA state representing the status of the order in your warehouse.
refundedThe refunded state can only be assigned with this end-point if the order has NO order items. IF the order HAS order items, this state can only get triggered by the status of the order items.


Do you want to know more about order states and event? Please find the page under the link: Explaining Statuses and Events


Did you find it helpful? Yes No