Description

  • Query Order List API
Request URL
  • /rest/sc_api/order/list
Request Method
  • POST
Common Parameter (Request Header)
Request Parameter (Request Body)
Name Data Type Mandatory Description
order_no String[] N order no of Orders. limit 50
order_status String[] N status of Order.
order_date_from Long N from date of order_date range.
order_date_to Long N to date of order_date range.
offset Int N Number of datas to skip at the beginning of the list. Default 0.
limit Int N The maximum number of datas that can be returned. The supported maximum number is 50.
Request Example
{
    "offset": 0,
    "limit": 50,
    "order_no": ["Order123456", "Order123457"],
    "order_status": ["CREATED", "PAID"],
    "order_date_from": 1727346000916,
    "order_date_to": 1727347000916
}
Order Standard Response Properties Definition (Object[])
Name Data Type Description
order_no String Description of order no
order_type String Description of order type
sales_channel String Sales Channel Name defined by user
upstream_system String Name of Upstream Marketplace System. Applicable values: Shopee, Lazada, Tiktok, Shopify and General
order_status String Description of order status
order_date Integer Date related to the order date (in UNIX timestamp)
last_updated_date Integer Date related to the last updated date (in UNIX timestamp)
cross_border Integer Description of cross border
campaign_id String Unique identifier for campaign id
ref_code String Description of ref code
ship_by_date Integer Date related to the ship by date (in UNIX timestamp)
upstream_allow_split Integer Description of upstream allow split
currency String Description of currency
country String Description of country
customer_remark String Description of customer remark
seller_remark String Description of seller remark
customer_id String Unique identifier for customer id
customer_name String Name of the customer name
customer_email String Description of customer email
customer_phone String Description of customer phone
shipping_info Object Description of shipping info
├─ country String Country Code(2 digit ISO code)
├─ city String Description of city
├─ state String Description of state
├─ district String Description of district
├─ address String Description of address
├─ postcode String Description of postcode
├─ name String Name of the name
├─ email String Description of email
├─ phone String Description of phone
├─ organization String Description of organization
├─ requested_arrival_date Integer Date related to the requested arrival date (in UNIX timestamp)
├─ time_window_from String Description of time window from
├─ time_window_to String Description of time window to
├─ delivery_carrier String Description of delivery carrier
├─ delivery_type String Description of delivery type
├─ shipping_description String Description of the shipping description
payment_info Object Description of payment info
├─ sub_total Double Description of sub total
├─ buyer_shipping_fee Double Description of buyer shipping fee
├─ discount Double Description of discount
├─ tax Double Description of tax
├─ grand_total Double Description of grand total
├─ paid_amount Double Unique identifier for paid amount
├─ balance Double Description of balance
├─ platform_voucher Double Description of platform voucher
├─ platform_coin Double Description of platform coin
├─ seller_voucher Double Description of seller voucher
├─ seller_coin Double Description of seller coin
├─ payment_method String Description of payment method
income_info Object Description of income info
├─ platform_shipping_fee Double platform shipping fee
├─ platform_commission_fee Double platform commission fee
├─ payment_transaction_fee Double payment transaction fee
├─ seller_discount Double Order level seller discount
├─ order_income Double Order level final income for seller
items Object[] Description of items
├── sc_sku_code String marketplace generated sku code
├── seller_sku_code String seller sku code defined by seller as identifer
├── sku_name String Name of the sku name
├── unit_price Double retail price of unit
├── qty Integer purchase qty
├── total Double sub total of order item
├── discount Double item level discount
├── discount_from_seller Double discount from seller for this item
├── discount_from_platform Double discount from platform for this item
├── final_price Double final price after discount, depends on marketplace, usually it's final paid amount
├── order_id Integer Unique identifier for order id
├── status String Description of status
├── orig_order_item_id Integer Unique identifier for orig order item id
├── delivery_carrier String Description of delivery carrier
├── delivery_type String Description of delivery type
├── ship_by_date Integer Date related to the ship by date (in UNIX timestamp)
├── sc_spu_id String Unique identifier for sc spu id
├── use_upstream_tpt Integer Description of use upstream tpt
├── req_fp_gen_track_no Integer Description of req fp gen track no
parcel_info Object[] Description of parcel info
├── parcel_id Integer Unique identifier for parcel id
├── parcel_type String Description of parcel type
├── created_date Integer Date related to the created date (in UNIX timestamp)
├── fulfillment_point String Description of fulfillment point
├── fp_parcel_no String Description of fp parcel no
├── us_parcel_no String Description of us parcel no
├── status String Description of status
├── weight Double Description of weight
├── length Double Description of length
├── height Double Description of height
├── width Double Unique identifier for width
├── tracking_no String Description of tracking no
├── source_location String Description of source location
├── dest_location String Description of dest location
├── waybill_url String Description of waybill url
├── items Object[] Description of items
├──── orig_order_item_id Integer Unique identifier for orig order item id
├──── order_item_status String Description of order item status
├──── sc_spu_id String Unique identifier for sc spu id
├──── sc_sku_code String Description of sc sku code
├──── sku_code String Description of sku code
├──── sku_name String Name of the sku name
├──── qty Integer Description of qty
├──── weight Double Description of weight
├──── brand_name String Name of the brand name
├──── brand_sku_code String Description of brand sku code
Success Response Example
  {
   "code": "200",
   "data": [
   {
      "order_no": "SHOPEE001",
      "order_type": "DELIVERY",
      "order_status": "PAID",
      "order_date": 1616317631,
      "last_updated_date": 1616317631,
      "cross_border": 0,
      "campaign_id": "string",
      "ref_code": "string",
      "ship_by_date": 1616317631,
      "upstream_allow_split": 1,
      "currency": "SGD",
      "country": "SG",
      "customer_remark": "buyer remark",
      "seller_remark": "seller remark",
      "customer_id": "fengbowen",
      "customer_name": "Feng Bowen",
      "customer_email": "bowen.feng@ych.com",
      "customer_phone": "+6590537728",
      "shipping_info":{
            "city": "",
            "state": "",
            "district":"",
            "address": "Jurong West ST42,BLK432 #03-562,Singapore 640432",
            "postcode": "640432",
            "name": "Feng Bowen",
            "email": "bowen.feng@ych.com",
            "phone": "+6590537728",
            "organization": "Y3 Technologies",
            "requested_arrival_date": 1616317631,
            "time_window_from": "0930",
            "time_window_to": "1730",
            "delivery_carrier": "J&T Express",
            "delivery_type": "normal",
            "shipping_description":"XXXX" 
      },
      "payment_info": {
            "sub_total": 100.0,
            "buyer_shipping_fee": 5.0,
            "discount": 10.0,
            "tax": 10.0,
            "grand_total": 105.0,
            "paid_amount": 55.0,
            "balance": 50.0,
            "platform_voucher": 1.0, 
               "platform_coin": 1.0, 
            "seller_voucher": 1.0, 
            "seller_coin": 1.0, 
            "payment_method": "wechat" 
      },
      "income_info":{
           "platform_shipping_fee": 1.0, 
           "platform_commission_fee": 1.0, 
           "payment_transaction_fee": 1.0, 
           "seller_discount": 1.0, 
           "order_income": 1.0 
      },
      "items": [
          {
            "sc_sku_code": "2341657616_SGAMZ-13627915753",
            "seller_sku_code": "2341657616-1653465863871-0",
            "sku_name": "Carbon roast duck neck",
            "unit_price": 0.9000,
            "qty": 1,
            "total": 0.9000,
            "discount": 0.0000,
            "final_price": 0.9000,
            "order_id": 1979,
            "status": "CANCELLED",
            "orig_order_item_id": 3963,
            "delivery_carrier": "J&T Express",
            "delivery_type": "normal",
            "ship_by_date": 1616317631,
            "sc_spu_id": "123132",
            "use_upstream_tpt": 1,
            "req_fp_gen_track_no": 1 
           }
       ],
       "parcel_info":[{
            "parcel_id": 1212,
            "parcel_type": "",
            "created_date": 1616317631,
            "fulfillment_point":"FP0001",
            "fp_parcel_no": "PARCEL001",
            "us_parcel_no": "SHOPEE-PARCEL001",
            "status": "In Transit",
            "weight": 1.11,
            "length": 1.11,
            "height": 1.11,
            "width": 1.11,
            "tracking_no": "XXXXXXXXXXX",
            "source_location": "8 Bulim Ave, Singapore 648166",
            "dest_location": "",
            "waybill_url":"https://xxxxxxxxxx",
            "items":[{
                "orig_order_item_id": 1001,
                "order_item_status":"PACKED",
                "sc_spu_id": "1001",
                "sc_sku_code": "SHOPEE-SKU0001",
                "sku_code": "SKU001",
                "sku_name": "SKU001",
                "qty": 10,
                "weight": 1.11,
                "brand_name": "",
                "brand_sku_code": ""
            }]
       }]
    }
    ],
    "total_count": 1,
    "message": "success",
    "request_id": "2d48f902-7efa-4718-8b88-9686803a8a02"
  }
Error Response Example
© 2025 OMS4. all right reserved，powered by GitbookVersion: 1.13.0.20250320 Modify: 2025-05-09 10:52:59

results matching ""

    No results matching ""