Create Parcels

Request Method

http

POST /openapi/order/create-order

Field	Description
Content-Type	application/json
x-auth-token	$TOKEN
x-auth-name	$APP_NAME
x-auth-seed	$TS

Parameter

Field	Mandatory	Type	Description	Length
custom_tracking_num	Y	string	Custom Tracking Num Only alphanumeric characters including '-','_' are allowed	<= 32 characters
service_type	Y	string	To be advised by your account manager.	= 3 characters
service_code	Y	string	To be advised by your account manager.	= 3 characters
sender_name	N	string	Full Name of the sender. when "service_type=1XX" Mandatory	<= 64 characters
sender_phone	N	string	Phone number of sender. Digits only. Support following formats: Country calling code + phone, e.g. 8613012345678, 6586020000 Phone (Singapore numbers by default), e.g. 86020000. Please remove symbols like "+" in the phone number. For list of country calling code, see: List of country calling code Wikipedia. when "service_type=1XX" Mandatory	<= 24 characters
sender_email	N	string	Email address of sender Email address format: RFC 5321 Section-4.5.3.1.1.	<= 320 characters
sender_address	N	string	Address of sender. UTF-8 charset supported. when "service_type=1XX" Mandatory	<= 512 characters
sender_city	N	string	City name (include province/state) of sender.	<= 64 characters
sender_country	Y	string	All uppercase. For country code, we propose the format of ISO 3166-1 alpha 2 (two-letter). See ISO 3166-1 Alpha-2 Country Codes for more information.	= 2 characters
sender_postal_code	N	string	Postal code of sender. when "service_type=1XX and sender_country!=HK" Mandatory	5-20 characters
recipient_name	Y	string	Name of the recipient
recipient_phone	Y	string	Phone number of sender. Digits only. Support following formats: Country calling code + phone, e.g. 8613012345678, 6586020000 Phone (Singapore numbers by default), e.g. 86020000. Please remove symbols like "+" in the phone number. For list of country calling code, see: List of country calling code Wikipedia.	<= 24 characters
recipient_email	N	string	Email address of sender Email address format: RFC 5321 Section-4.5.3.1.1.	<= 320 characters
recipient_address	Y	string	Address of recipient. UTF-8 charset supported.	<= 512 characters
recipient_state	N	string	State of recipient. when "recipient_country=US/JP" Mandatory	<= 60 characters
recipient_city	N	string	City name (include province/state) of recipient. when "recipient_country=JP" Mandatory	<= 64 characters
recipient_country	Y	string	All uppercase. For country code, we propose the format of ISO 3166-1 alpha 2 (two-letter). See ISO 3166-1 Alpha-2 Country Codes for more information.	= 2 characters
postal_code	Y	string	If not 6-digits, will auto prefix leading 0. For instance, "38696" will be converted to "038696".	5-7 characters
client_size	Y	string	Format: Package size: "length, width, height" (comma separated, whitespace not mandatory). System will automatically adjust the order (from greatest to smallest). Unit: centimeter. Max value of l,w,h: 999 cm.	<= 30 characters
client_weight	Y	string	Package weight. Unit: kilogram. Numeric value with 2 decimal places.	[ 0 .. 9999 ]
declared_value_currency	Y	string	Currency code of declared value. Check Currency / Wikipedia for more information.	<= 3 characters
declared_value	Y	string	Declared value of the parcel. Numeric value with 2 decimal places.	[ 0 .. 9999.99 ]
instruction	N	string	Instructions from clients.	<= 1024 characters
cash_currency	N	string	NOTE: Currently, only "SGD" supported. If not specified, we will apply "SGD" to the datapoints. Currency code of cash on delivery value. Check Currency / Wikipedia for more information.	<= 3 characters
cash	N	string	Currency: Singpore dollar. Numeric value with 2 decimal places. Values like "12" will be converted to "12.00".	[ 0 .. 9999.99 ]
supplier_name	N	string	Name of the supplier. This field is mandatory when the recipient_country is "SG" (Singapore). For all other countries, this field is optional unless otherwise specified.	<= 64 characters
supplier_gstn	N	string	GST registration number (GSTN) of the Overseas Supplier registered under Overseas Vendor Registration (OVR) regime. This field is mandatory when the recipient_country is "SG" (Singapore). For all other countries, this field is optional unless otherwise specified.	<= 64 characters
total_gst_amount	N	string	Total amount of Goods and Services Tax (GST). This field is mandatory when recipientCountry is "SG" (Singapore). For all other countries, this field is optional unless specified otherwise.	[ 0 .. 9999.99 ]
gst_currency	N	string	Currency in which the GST amount is reported. This field is mandatory when recipientCountry is "SG" (Singapore). For other countries, this field is optional unless otherwise specified.	<= 3 characters
gst_paid	N	string	Indicates whether GST has been paid for the transaction. This field is mandatory when recipientCountry is "SG" (Singapore). "Y" – GST has been paid "N" – GST is not applicable	= 1 character
item	Y	Array of objects	Package product information
locker_type	N	string	"A" - Data already has locker address, no address change needed. "B" - Original data, need to convert to closest locker address.	= 1 character
locker_station	N	objects	when "locker_type=A" Mandatory

item

Field	Mandatory	Type	Description
description	Y	string	Trade name
unitPrice	Y	string	unit-price
quantity	Y	string	quantity
countryOfOrigin	Y	string	country of origin
itemHSCode	Y	string	HS Tariff Code of the Line Item.
weight	Y	string	weight
currency	Y	string	currency
totalValue	Y	string	total value
productURL	N	string	product url

locker_station

Field	Mandatory	Type	Description	Length
zipcode	Y	string	Zipcode	<= 16 characters
station_name	Y	string	Station Name	<= 64 characters
station_address	Y	string	Station Address	<= 255 characters
address_detail	Y	string	Address Detail	<= 255 characters
distance	Y	float	Distance
station_code	Y	string	Station Code	<= 10 characters

Request（eg:1）

json

{
  "custom_tracking_num": "C240719112805334a634B",
  "service_type": "001",
  "service_code": "000",
  "sender_name": "Mrs. Dawn Lowe",
  "sender_phone": "17129045947",
  "sender_email": "kiara93@hotmail.com",
  "sender_address": "42050 General Road\nOlehaven, IN 59521-5312",
  "sender_city": "Schowalterland",
  "sender_country": "MG",
  "sender_postal_code": "25280",
  "recipient_name": "Estrella Mohr",
  "recipient_phone": "13184732563",
  "recipient_email": "friesen.gloria@okon.com",
  "recipient_address": "97506 Sammy Garden Suite 681\nPort Louiefort, DC 32153-8863",
  "recipient_city": "New Adan",
  "recipient_country": "DO",
  "postal_code": "298469",
  "client_size": "7.72,3.5,17.66",
  "client_weight": "2.99",
  "declared_value_currency": "MGA",
  "declared_value": "913.11",
  "instruction": "I believe.' 'Boots and shoes.",
  "cash_currency": "MGA",
  "cash": "716.64",
  "item": [
    {
      "description": "Et qui sunt ut est.",
      "unitPrice": "205.95",
      "quantity": "1",
      "countryOfOrigin": "MG",
      "itemHSCode": "1818457376",
      "weight": "25.8",
      "currency": "MGA",
      "totalValue": "205.95",
      "productURL": "https:\/\/www.grimes.biz\/repellat-ea-odit-veritatis-non-veniam"
    },
    {
      "description": "Fugit et ipsa.",
      "unitPrice": "579.98",
      "quantity": "6",
      "countryOfOrigin": "MG",
      "itemHSCode": "1818630924",
      "weight": "3.18",
      "currency": "MGA",
      "totalValue": "3479.88",
      "productURL": ""
    }
  ]
}

Request（eg:2）

json5


{
    "service_type": "011",
    "custom_tracking_num": "C250909160024031941425",
    "service_code": "0C1",
    "sender_name": "Miss Kaylin Fisher Jr.",
    "sender_phone": "16508405567",
    "sender_email": "stokes.lydia@zieme.net",
    "sender_address": "779 Juanita Valleys\nEast Shyann, NV 13839-8168",
    "sender_city": "North Lorenview",
    "sender_country": "HK",
    "sender_postal_code": "000276",
    "recipient_name": "Ms. Chanelle Mann DDS",
    "recipient_phone": "16056559118",
    "recipient_email": "angelica07@daugherty.net",
    "recipient_address": "4539 Ledner Pike Suite 107\nPort Milford, WY 44135-6494",
    "recipient_city": "South Floview",
    "recipient_country": "SG",
    "postal_code": "495229",
    "client_size": "2.28,2.62,3.24",
    "client_weight": "3.13",
    "declared_value_currency": "HKD",
    "declared_value": "57.52",
    "instruction": "She had quite forgotten the.",
    "cash_currency": "SGD",
    "cash": 358.73,
    "item": [
        {
            "description": "Minima id in.",
            "unitPrice": 7.8,
            "quantity": 6,
            "countryOfOrigin": "HK",
            "itemHSCode": "895702",
            "weight": 1.15,
            "currency": "SGD",
            "totalValue": "46.80",
            "productURL": ""
        },
        {
            "description": "Quia molestias eos.",
            "unitPrice": 1.34,
            "quantity": 8,
            "countryOfOrigin": "HK",
            "itemHSCode": "30950860",
            "weight": 1.98,
            "currency": "SGD",
            "totalValue": "10.72",
            "productURL": "http:\/\/www.kassulke.com\/"
        }
    ],
    "locker_type": "A",
    "locker_station": {
        "zipcode": "544774",
        "station_name": "AParcel Santa - Terrasse",
        "station_address": "- 21 Terrasse Ln, Singapore 544774",
        "address_detail": "Terrasse, Arcadia Clubhouse 1, basement, outside MA office",
        "distance": 197.977,
        "station_code": "PK1689"
    },
    "supplier_name": "Diamond O'Connell",
    "supplier_gstn": "250909160024324039200",
    "total_gst_amount": 6.67,
    "gst_currency": "SGD",
    "gst_paid": "N"
}

Response(success)

json

{
  "code": 0,
  "message": "success",
  "data": {
    "custom_tracking_num": "C240719112805334a634B",
    "wmg_tracking_num": "WGC000000000233",
    "date_time": "2024-07-19T13:34:26+08:00",
    "status": "",
    "error": []
  }
}

Response(error)

json

{
  "code": 1,
  "message": "Client Size invalid",
  "data": []
}

Create Parcels ​

Request Method ​

Header ​

Parameter ​

Request（eg:1） ​

Request（eg:2） ​

Response(success) ​

Response(error) ​

Create Parcels

Request Method

Header

Parameter

Request（eg:1）

Request（eg:2）

Response(success)

Response(error)