Description
  • Order creation Interface
Request URL
  • /rest/sc_api/order/create
Request Method
  • POST
Content-Type
  • application/json
Common Parameter (Request Header)
Request Parameter (Request Body)
Name Data Type Mandatory Description
order_no String Y order no which is generated by sales channel system.
order_type String N type of order.
order_status String Y set by system, Should Follow definition of OMS4 Order Status flow.CREATED/PAID
created_date Long Y original order generated date.(Sales Channel order creation date).
updated_date Long Y original order updated date.(Sales Channel order updated date).
cross_border Int N whether is cross border order or not. default false.
campaign_id String N
ref_code String N
ship_by_date Long N The deadline to ship out the parcel. It's timestamp with millisecond.
upstream_allow_split Int Y whether upstream system allow split order or not. Default 0 (false).
currency String Y currency code (3-digit ISO code)
country String Y
customer_remark String N buyer remark.
seller_remark String N seller remark.
customer_id String N buyer customer id of sales channel.
customer_name String N buyer customer name
customer_email String N buyer customer email. Need to do basic validation of standard email format.
customer_phone String N phone no of buyer.
shipping_info Object N shipping (delivery) info
├──state String N
├──city String N
├──district String N
├──address String N
├──postcode String N
├──name String N
├──email String N Need to do basic validation of standard email format.
├──phone String N
├──organization String N
├──requested_arrival_date Long N request arrival date. It's timestamp with millisecond.
├──time_window_from String N accept delivery time window from. format should be "HH:mm" - "09:00"
├──time_window_to String N accept delivery time window to. format should be "HH:mm" - "20:30"
├──shipping_description String N
payment_info Object N payment info
├──sub_total Double N
├──buyer_shipping_fee Double N shipping fee.
├──discount Double N
├──tax Double N
├──grand_total Double N
├──paid_amount Double N
├──balance Double N
├──platform_voucher Double N
├──platform_coin Double N
├──seller_voucher Double N
├──seller_coin Double N
├──payment_method String N
income_info Object N income info
├──platform_shipping_fee Double N
├──platform_commission_fee Double N
├──payment_transaction_fee Double N
├──seller_discount Double N
├──order_income Double N
items Object[] Y order items
├──sc_sku_code String N sales channel sku code
├──seller_sku_code String Y seller sku code
├──sku_name String N sku name
├──unit_price Double N
├──qty Int Y
├──total Double N
├──discount Double N
├──final_price Double N
├──orig_order_item_id String Y original order item id which is generated by upstream system such as Shopee or Lazada.
├──delivery_carrier String Y transporter such as J&T Express.
├──delivery_type String Y type of delivery.
├──ship_by_date Long Y The deadline to ship out the parcel. It's timestamp with millisecond.
├──sc_spu_id String Y sales channel spu id.
├──use_upstream_tpt Int N whether use upstream system integrated TSP(Transportation Service Provider) or 1/0, Default: 0
├──req_fp_gen_track_no Int Y whether require fulfillment point generate & provide tracking number to OMS4 or not. Default 0 (false).
Request Example
{
    "currency": "USD",
    "country": "SG",
    "items": [{
            "qty": 5,
            "total": 100.00,
            "discount": 5.00,
            "sc_sku_code": "SC123456",
            "seller_sku_code": "Seller123456",
            "sku_name": "SKU1",
            "unit_price": 20.00,
            "final_price": 95.00,
            "orig_order_item_id": "Orig123456",
            "delivery_carrier": "J&T",
            "delivery_type": "Standard",
            "ship_by_date": 1727345777022,
            "sc_spu_id": "SPU123456",
            "use_upstream_tpt": 1,
            "req_fp_gen_track_no": 1
        }
    ],
    "order_no": "Order123456",
    "order_type": "Type1",
    "order_status": "CREATED",
    "created_date": 1727345777011,
    "updated_date": 1727345777011,
    "cross_border": 0,
    "campaign_id": "Campaign1",
    "ref_code": "Ref1",
    "ship_by_date": 1727345777011,
    "upstream_allow_split": 1,
    "customer_remark": "Remark1",
    "seller_remark": "Remark2",
    "customer_id": "Customer1",
    "customer_name": "Name1",
    "customer_email": "email@example.com",
    "customer_phone": "1234567890",
    "shipping_info": {
        "state": "State1",
        "city": "City1",
        "district": "District1",
        "address": "Address1",
        "postcode": "12345",
        "name": "Name1",
        "email": "email@example.com",
        "phone": "1234567890",
        "organization": "Org1",
        "requested_arrival_date": 1727345777011,
        "time_window_from": "09:00",
        "time_window_to": "17:00",
        "delivery_carrier": "J&T",
        "delivery_type": "Standard",
        "shipping_description": "Description1"
    },
    "payment_info": {
        "discount": 5.00,
        "tax": 15.00,
        "balance": 0.00,
        "sub_total": 100.00,
        "buyer_shipping_fee": 10.00,
        "grand_total": 120.00,
        "paid_amount": 120.00,
        "platform_voucher": 0.00,
        "platform_coin": 0.00,
        "seller_voucher": 0.00,
        "seller_coin": 0.00,
        "payment_method": "Method1"
    },
    "income_info": {
        "platform_shipping_fee": 10.00,
        "platform_commission_fee": 10.00,
        "payment_transaction_fee": 2.00,
        "seller_discount": 5.00,
        "order_income": 73.00
    }
}
Create Order Standard Response Properties Definition
Name Data Type Description
order_id Integer Unique identifier for order id
order_no String Description of order no
order_type String Description of order type
upstream_system String Description of upstream system
sales_channel_id String Unique identifier for sales channel id
sales_channel String Description of sales channel
order_status String Description of order status
campaign_id String Unique identifier for campaign id
ref_code String Description of ref code
customer_remark String Description of customer remark
seller_remark String Description of seller remark
cross_border Integer Description of cross border
delivery_carrier String Description of delivery carrier
delivery_type String Description of delivery type
upstream_allow_split Integer Description of upstream allow split
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
ship_by_date Integer Date related to the ship by date (in UNIX timestamp)
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
currency String Description of currency
shipping_fee Double Description of shipping fee
sub_total Double Description of sub total
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
order_date Integer Date related to the order date (in UNIX timestamp)
created_by String Description of created by
created_date Integer Date related to the created date (in UNIX timestamp)
updated_by String Date related to the updated by (in UNIX timestamp)
last_updated_date Integer Date related to the last updated date (in UNIX timestamp)
active Integer Description of active
shipping_description String Description of the shipping description
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
platform_shipping_fee Double Description of platform shipping fee
platform_commission_fee Double Description of platform commission fee
payment_transaction_fee Double Description of payment transaction fee
seller_discount Double Description of seller discount
order_income Double Description of order income
items Object[] Description of items
├── order_item_id Integer Unique identifier for order item id
├── order_id Integer Unique identifier for order id
├── line_no Integer Description of line no
├── orig_order_item_id String 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
├── seller_sku_code String Description of seller sku code
├── sku_name String Name of the sku name
├── sc_sku_code String Description of sc sku code
├── qty Integer Description of qty
├── unit_price Double Description of unit price
├── total Double Description of total
├── discount Double Description of discount
├── final_price Double Description of final price
├── use_upstream_tpt Integer Description of use upstream tpt
├── req_fp_gen_track_no Integer Description of req fp gen track no
shipping_info Object Description of shipping info
├─ name String Name of the name
├─ email String Description of email
├─ phone String Description of phone
├─ organization String Description of organization
├─ country String Description of country
├─ state String Description of state
├─ city String Description of city
├─ district String Description of district
├─ address String Description of address
├─ postcode String Description of postcode
Success Response Example
    {
   "code": "string",
   "data": {
       "order_id":1,
       "order_no": "SHOPEE001",
       "order_type": "E-commerce",
       "upstream_system": "Shopee",
       "sales_channel_id": "ID",
       "sales_channel": "shopee-sg-11111",
       "order_status": "PAID",
       "campaign_id": "string",
       "ref_code": "string",
       "customer_remark": "buyer remark",
       "seller_remark": "seller remark",
       "cross_border": 0,
       "delivery_carrier": "J&T Express",
       "delivery_type": "normal",
       "upstream_allow_split": 1,
       "requested_arrival_date": 1616317631,
       "time_window_from": "0930",
       "time_window_to": "1730",
       "ship_by_date": 1616317631,
       "customer_id": "fengbowen",
       "customer_name": "Feng Bowen",
       "customer_email": "bowen.feng@ych.com",
       "customer_phone": "+6590537728",
       "currency": "SGD",
       "shipping_fee": 5.0,
       "sub_total": 100.0,
       "discount": 10.0,
       "tax": 10.0,
       "grand_total": 105.0,
       "paid_amount": 55.0,
       "balance": 50.0,
       "order_date": 1616317631,
       "created_by": "shopee_default",
       "created_date": 1616317631,
       "updated_by": "admin",
       "last_updated_date": 1616317631,
       "active": 0,
       "shipping_description":"XXXX",
       "platform_voucher": 1.0,
       "platform_coin": 1.0,
       "seller_voucher": 1.0,
       "seller_coin": 1.0,
       "payment_method": "wechat",
       "platform_shipping_fee": 1.0,
       "platform_commission_fee": 1.0,
       "payment_transaction_fee": 1.0,
       "seller_discount": 1.0,
       "order_income": 1.0,
       "items": [
           {
           "order_item_id": 1,
           "order_id": 1,
           "line_no": 1,
           "orig_order_item_id": "100001",
           "delivery_carrier": "J&T Express",
            "delivery_type": "normal",
               "ship_by_date": 1616317631,
           "sc_spu_id": "100001",
           "seller_sku_code": "SKU001",
           "sku_name": "IPHONE12 Plus",
           "sc_sku_code": "SHOPEE-SKU0001",
           "qty": 10,
           "unit_price": 10.0,
           "total": 100.0,
           "discount": 1.0,
           "final_price": 9.0,
           "use_upstream_tpt": 1,
           "req_fp_gen_track_no": 1 
           }
       ],
       "shipping_info": {
       "name": "Feng Bowen",
       "email": "bowen.feng@ych.com",
       "phone": "+6590537728",
       "organization": "Y3 Technologies",
       "country": "SG",
       "state": "",
       "city": "",
       "district": "",
       "address": "Jurong West ST42,BLK432 #03-562,Singapore 640432",
       "postcode": "640432"
       }
    },
   "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:35:02

results matching ""

    No results matching ""