Order Status Distributors

DOWNLOAD SPEC

Getting Started

Authentication guide 
 
This API uses API keys to authenticate and allow access to the API. 

Your API keys carry many privileges, so be sure to keep them secure! 

To know more about the authentication process, have a look at the dedicated authentication documentation.

 For any authentication request and know if you are eligible for API onboarding please contact your local SE API Manager or SE API Team at distributorapiportal.global@se.com  

Services 
 
Order Status API includes 3 levels of services, those are link to a predefine account number and country:

 • General information about all orders  

 • General information about a specific order

 • General information about an order according to a status  

 • Item details of an order  

 • Shipping schedule of an item 

How it works

1. Request structure: Input Parameters  
 
URL for Order Status API in Production: https://api.se.com/v1/supply-chain/partner-order-status 
 
There are 3 endpoints(GET). The request structure is detailed for each of the endpoints:   
 
1.1. Search for orders: https://api.se.com/v1/supply-chain/partner-orderstatus/orders/{country} 
 
This method is used to find all the orders linked to an account. The only one mandatory input parameter is the country code (e.g. France=FR, Russia=RU, Brazil=BR…), other parameters are optional.  If there are more than 200 orders in the list, please use pagination.  
 
       1.1.1. Pagination  

 Each page has 200 orders maximum. By using pagination, you can get :

  •   "totalNumberOfRecords” corresponds to the number of all the orders of the account

  •   "pageNumber" corresponds to the page you are seeing

  •   "totalNumberOfPages" corresponds to the number of pages to cover the "totalNumberOfRecords” 
 
       1.1.2. If the total number of orders is > 200, What parameters should I use?  
 
It is recommended to filter as much as possible your query to have a limited "totalNumberOfRecords”. There are 4 recommended parameters:  
 
/{country}?order-status={orderStatusCode} corresponds to the status of the order define on the ERP  

/{country}?purchaserid={purcharserid} corresponds to the purchaser ID with which the order as been submitted

 • /{country}&page-size={NumberofOrders} corresponds to the number of orders to be displayed on one page

/{country}&page={pageNumber} corresponds to the page of result to return  

1.2. Order and item details: https://api.se.com/v1/supply-chain/partner-orderstatus/orders/{country}/{order-number} 
 
This method is used to find details of a specific order . In addition to the country code, one more mandatory input to provide: the order number.  An order can contain multiple items. An Item line generally correspond to a quantity of a product/service (< 1 qty) starting from 000010

 • /{country}/{{order-number}/{item-number} to get information on one specific item of an order  
 
1.3. Shipment details: https://api.se.com/v1/supply-chain/partner-orderstatus/orders/{country}/{order-number}/{item-number}/shipment-schedules  
 
This method is used to find information about an order’s item shipment information and details.  One product of an order (which is equal to one line or item in the order) can have several shipping schedules and each shipping schedule can have several sets of tracking information. In addition to the country code, to the order number and to the item number, one more mandatory input parameter to provide: the shipment schedule.

/{country}/{{order-number}/{item-number}/shipment-schedules to get all the details regarding the items shipment and track it with precision.