Sales Channel Open API Overview
Sales Channel Open API is mainly focus the integration between OMS4 and Upstream marketplace system(private on-line store / brand.com) to automate and digitalize product listing / order fulfillment process. In this case, make sure the type of Sales Channel created in OMS4 is General.
Meanwhile for those sales channel of public and commercial e-marketplace like Shopee, Lazada etc. OMS4 also provide capabilities to allow 3rd party system(ERP) to do integration via Open API.
The table below lists APIs that can be used for sales channel/ERP system.
| API Name | Description | General Sales Channel | Others Sales Channel |
|---|---|---|---|
| Create Order | Provide API for upstream system to create order | Supported | Not Supported |
| Get Orders | Get list of order information with details | Supported | Supported |
| Get Parcels | Get Parcels details by list of Order No or FP Parcel No | Supported | Supported |
| Track & Trace | Retrieve track & trace info by list of Order No or Tracking No | Supported | Not Supported |
| Update Parcel Status | Update Parcel status of order | Supported | Not Supported |
| Update Parcel Tracking Docs | Update Parcel relevant tracking docs of order | Supported | Not Supported |
| Cancel Order | Full/Partial Cancel order | Supported | Not Supported |
| Request to Cancel Order | Raise Cancellation Request for order | Supported | Not Supported |
| Update Upstream SPU Base Info | Create/Update basic info of Upstream SPU | Supported | Not Supported |
| Delete Upstream SPU | Delete Upstream SPU info in OMS4 | Supported | Not Supported |
| Update Upstream SPU Status | Update Upstream SPU status in OMS4 | Supported | Not Supported |
Use Cases
For General Type of Sales Channel:
Like those commercial e-marketplace such as Shopee & Lazada, once buyer purchased order, this order need to be flowed into OMS4 for order fulfillment, subsequently may also need to update parcel info such as Delivery Carrier, Tracking No and Waybill docs to OMS4.
Meanwhile, if there is order cancellation and buyer cancellation request, OMS4 also provide API to allow upstream marketplace system to forward them into OMS4 system to proceed accordingly.
For Others Type(Shopee, Lazada etc) of Sales Channel
Usually the use case will be integrated with customer ERP System to sync order relevant information.