Order Status API

Custom Gateway has developed an order status API to allow the order status of each order to be updated.

 

The following are examples of the API calls required to set the status of orders received from OMS platform via API:

 

There are two standard status options supported; dispatch and cancel, depending on whether an order can be fulfilled or not. To dispatch an order using the API, the following call should be executed:

 

Dispatch:

To indicate that an order is fulfilled, the following call should be executed:

 

curl -X PUT -d '{ "status": 8 }' -H "authorization: basic REFID:APIKEY" -H "content-type: application/json" "https://api-sl-2-2.custom-gateway.net/order/:id/status"

This also supports submitting tracking numbers example below

curl -X PUT -d '{ "status": 8, "shipping_tracking": "ABC"}' -H "authorization: basic REFID:APIKEY -H "content-type: application/json" "https://api-sl-2-2.custom-gateway.net/order/:id/status",

Cancel:

To cancel an order, where it cannot be fulfilled, the following call should be executed:

 

curl -X PUT -d '{ "status": 128 }' -H "authorization: basic REFID:APIKEY" -H "content-type: application/json" "https://api-sl-2-2.custom-gateway.net/order/:id/status"

 

In each case, :id is our the order ID we will pass when sending orders.

Please note that Sales Channel companies can also Cancel Orders, this was a recent update to the Order Status API. 

Other supported order status codes:

 

The following status codes are also supported by the API:

 

Generally your status callback would not need to handle all possible order statuses.

• † denotes a status that you should handle at a minimum.
  

Status Code	Status Name	Description
8†	Dispatched	The order has been fully dispatched.
32	QC Query	The order has a QC query against it.
64	Dispatched (Retailer Notified)	Dispatch confirmation has been explicitly pushed to the retailer by Custom Gateway.
128	Cancelled	The order has been cancelled.
256	On Hold	The order is on hold.
512	Sent to Supplier	The order has been routed to an appropriate supplier.
513	Received by Supplier	The order has been confirmed as received by an appropriate supplier.
515	Sent to Shipper	The order details have been sent to a shipment courier (such as UPS or DPD).
516†	Received by Shipper	The order details have been confirmed by a shipment courier.

• Related Articles

• Standard Order Details Export API

  Kornit X have an API which can be called to gather order details from the OMS in JSON format. To utilise this you need to have an OMS OAUTH use set up and tied to the companies that you need to report on. If you do not have an OAUTH user you can ...

• Red Bubble API

  Red Bubble is an eCommerce artist portal that hosts millions of artwork designs by independent artists from all around the world. The artwork is available for purchase, on demand, printed on anything from clothing & apparel to home decor & ...

• Notification Integration | Generic API

  Introduction Kornit X has built a notification integration to connect to a Generic API. This notifications integration will alert the customers whenever an order has been received, dispatched and delivered. Integration Setup For orders that you have ...

• Supplier Integration | Generic API

  Introduction The Order Push API from Kornit X is our generic Order Manager API allowing us to POST order data in JSON format (matching the structure of our standard orders in API) to an endpoint nominated by a supplier. This is a cheaper alternative ...

• Production Integration - Generic API

  Introduction The Generic API production integration pushes batch data and related order data, in JSON format, to an API endpoint.  The integration makes it easy for fulfillers with in-house developers, to ingest this data and produce jobs outside of ...