Appearance
Create Parcels
Request Method
http
POST /openapi/order/create-ordersHeader
| Field | Description |
|---|---|
| Content-Type | application/json |
| x-auth-token | $TOKEN |
| x-auth-name | $APP_NAME |
| x-auth-seed | $TS |
Parameter
Orders
| Field | Mandatory | Type | Description | Length |
|---|---|---|---|---|
| custom_tracking_num | Y | string | Custom Tracking Num Only alphanumeric characters including '-','_' are allowed | <= 32 characters |
| service_code | N | string | To be advised by your account manager. Default '' | = 3 characters |
| sender_name | N | string | Full Name of the sender. | <= 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. | <= 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. | <= 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 / Wikipedia for more information. | = 2 characters |
| sender_postal_code | N | string | Postal code of sender. | 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_city | N | string | City name (include province/state) of recipient. | <= 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 / Wikipedia 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 ] |
| item | Y | Array of objects | Package product information |
item
| Field | Mandatory | Type | Description | Length |
|---|---|---|---|---|
| description | Y | string | Trade name | |
| unitPrice | Y | string | unit-price | |
| quantity | Y | string | quantity | |
| countryOfOrigin | N | string | country of origin | |
| itemHSCode | N | 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 |
Request
json
{
"orders": [
{
"custom_tracking_num": "C240719112801849950gAA",
"service_code": "COM",
"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": ""
},
{
"description": "Quibusdam sit sint.",
"unitPrice": "286.06",
"quantity": "9",
"countryOfOrigin": "MG",
"itemHSCode": "370303",
"weight": "44.14",
"currency": "MGA",
"totalValue": "2574.54",
"productURL": ""
},
{
"description": "Qui voluptas quas.",
"unitPrice": "840.42",
"quantity": "7",
"countryOfOrigin": "MG",
"itemHSCode": "48996115",
"weight": "48.36",
"currency": "MGA",
"totalValue": "5882.94",
"productURL": ""
}
]
},
{
"custom_tracking_num": "C240719112801849A950gAA",
"service_code": "COMaa",
"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": ""
},
{
"description": "Quibusdam sit sint.",
"unitPrice": "286.06",
"quantity": "9",
"countryOfOrigin": "MG",
"itemHSCode": "370303",
"weight": "44.14",
"currency": "MGA",
"totalValue": "2574.54",
"productURL": ""
},
{
"description": "Qui voluptas quas.",
"unitPrice": "840.42",
"quantity": "7",
"countryOfOrigin": "MG",
"itemHSCode": "48996115",
"weight": "48.36",
"currency": "MGA",
"totalValue": "5882.94",
"productURL": ""
}
]
}
]
}Response(success)
json
{
"code": 0,
"message": "success",
"data": {
"success": [
{
"custom_tracking_num": "C240719112801849950gAA",
"date_time": "2024-07-19T13:30:48+08:00",
"status": "Accepted",
"error": []
}
],
"errors": [
{
"custom_tracking_num": "C240719112801849A950gAA",
"date_time": "2024-07-19T13:30:48+08:00",
"status": "Rejected",
"error": [
{
"reason": "Service Code invalid"
}
]
}
]
}
}