Order Status Main Account

This API provides current order status, order shipment schedule and also list of items in the order based on parameters passed in the request. Returned information is based on the registered buying account.

DOWNLOAD SPEC

Order Status API for Direct Customers (Distributors)

This API provides order status information to the distributor or main customer who placed the order (aka ship-to party). It allows them to track the status of all their orders, even if the goods are being shipped to multiple different locations (ship-to parties), such as points of sale or subsidiary accounts.

Use case: A distributor wants to monitor the status of all orders they’ve placed, regardless of where the products are being delivered.

With Order Status API, you can:

  • View a complete list of your orders
  • Access detailed line-by-line order information
  • Track shipping status for individual items

It’s a powerful tool to streamline order tracking and reduce manual follow-ups. Many of our customers use it to integrate order visibility directly into their internal systems—eliminating the need to contact customer support.

We can help you to explore how this API can simplify your operations.

Country Availability Assessment - Catalog of countries where we have conducted performance, availability, and response time testing for this API:

  • Argentina, Australia, Belgium, Brazil, Bulgaria, Canada, Chile, Colombia, Croatia, Denmark, Finland, France, Germany, India, Mexico, Netherlands, New Zealand, Norway, Peru, Portugal, Romania, Slovenia, Spain, Sweden, Switzerland, Turkey, United Kingdom and United States.

If your country is not included in the list, please feel free to reach out to us directly or contact your designated Schneider Point of Contact (POC) to inquire about the API's accessibility in your country. 

API Access will require oAuth authentication, please refer to the details on portal.

  • This API supports pagination, please refer to below details to understand how pagination works:
  • When API is requested with parameters to return very long list of items, response is paged in order to avoid heavy payload and n/w congestion.
  • A request parameter can be set to indicate how many items should be returned in single API response. (page-size<=100)
    Note: Default page size is 10
  • Each API response also returns parameters such as totalNumberOfRecords, totalNumberOfPages and pageNumber.
    • totalNumberOfRecords : How many records are eligible to be returned in response as per params passed in the request
    • totalNumberOfPages : How many pages are expected based on current pageSize and total number of records. E.g., 100 records with page-size 10 will require 10 pages.
    • pageNumber : for which page number response is required.

Parameters supported in the API:

ParameterData-typeDescriptionExample
countrystringCountry code for which order details are required.US
order-numberstringOrder number in ERP, this can be entire order value or “startingFrom” valueAB12345
order-statusstringCurrent order status in ERPDelivered
pagestringCurrent page number as per numberOfRecords and page-size1
page-sizestringNumber of records expected in response10
item-numberstringItem number of a particular item in the order79895
purchaser-idstringA 10-digit or 5-digit ID of the purchaser used in mySE1000006792

 

This API supports 3 operations as follows:

ResourcePathMandatory ParamsOptional ParamsExpected Response
/orders/{country}countryorder-number, order-status, page, page-size, purchaser-idAll orders linked to account in requested country
/orders/{country}/{order-number}/{item-number}/shipment-schedulescountry,
order-number,
item-number
purchaser-idShipment schedule of requested line-item in order will be returned
/orders/{country}/{order-number}country,
order-number
item-number, purchaser-idGeneral information along with shipment schedule of items/item in order is returned.
osd