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

• Production Job Status Overview

  Detailed below is an overview of the production job status options and how they are set   Status  How Set  Filling All jobs are allocated to a batch or routing template which can have a capacity set before they are released to the shop floor. Jobs ...

• Standard Order Details Export API

  Kornit X have an API which can be called to gather order details from the OMS in JSON format. This function is available to users who have an Order Manager subscription or higher and is not available to OMS lite or free users. To utilise this you ...

• Standardised Order Errors | Setup

  Introduction The following article has been created to detail how to set up standardised order errors enabling a clearer & more concise way to report back error patterns from the fulfiller by grouping these by error type in the Kornit X Platform & ...

• Order Manager | Returns

  Introduction Returns is a part of the Kornit X Sales module, allowing for customers to request a return which can then be managed and returned to a return bin on individual orders. Once an item has been returned a Return Shipping Label will be ...

• Order Manager | Customer Services: Finding Order Information and FAQ's

  Overview This document will outline how the system can be used to address common order and customer service based queries experienced by Retailers (and Fulfillers). The Platform is designed to offer a self service Order Management System. Retailers ...