Skip to content

Create Parcels

Request Method

http
POST /api/parcel/push-parcel-orders

NOTE

Asynchronous creation of orders.

This API allows you to pre-populate parcel data in our database to ensure a faster Get Shipping Label experience. This is the preferred method of manifestation. Steps for this API are as follows:

  1. Create Batch Parcels
  2. Get Tracking No.
  3. Get Shipping Label

If you have any queries, please write in to tech@wmg-group.com attaching your code and error messages. Thank you.

FieldDescription
Content-Typeapplication/json
AuthorizationBearer <token>

Parameter

Orders

FieldMandatoryTypeDescriptionLength
OwnerIdNNumericThe Company Id representing the
originator of the order record.
- Use 111 for OwnerId
Numeric (Mandatory)
ServiceCodeYStringTo be advised by your account manager.= 5 characters
MAWBNumberNStringAir Waybill Number.
Your shipping Document Number.
<= 30 characters
TrackingNumberYStringTracking Number as show on the shipping label on each item.<= 50 characters
SendingAgentIDNStringCustomer/Manufacturer reference number if any.<= 50 characters
SenderNameYStringThe Sender’s Name of the sender<= 60 characters
SenderCompanyNStringThe Sender’s Company Name if available. Default to “” if not available.<= 80 characters
SenderAddress1YStringThe Sender’s Address<= 160 characters
SenderAddress2NStringSender’s Address. Default to “” if not use<= 100 characters
SenderCityNStringSender’s City. Default to “” if not use<= 50 characters
SenderStateNStringSender’s State. Default to “” if not use<= 50 characters
SenderCountryYStringSender’s Country Name.<= 60 characters
SenderPostalCodeYStringSender’s Postal Code
To be fill up for those country that has
postal code. Otherwise default to “” for
those country that do not use post code.
<= 20 characters
SenderContactNoNStringContact Number of the Sender
Default to “” if not use.
<= 20 characters
SenderEmailNStringEmail of the Sender.
Default to “” if not use.
<= 100 characters
RecipientNameYStringName of Consignee<= 60 characters
RecipientCompanyNStringCompany of Consignee
Default to “” if not use.
<= 80 characters
RecipientAddress1YStringAddress of Consignee,The total length of three address characters cannot exceed 320<= 160 characters
RecipientAddress2NStringConsignee Address Line 2
Default to “” if not use.
<= 160 characters
RecipientAddress3NStringConsignee Address Line 3
Default to “” if not use.
<= 100 characters
RecipientCityYStringCity of Consignee
Default to “” if not use.
<= 50 characters
RecipientStateYStringState of Consignee
Default to “” if not use.
<= 50 characters
RecipientCountryYStringCountry Name of Consignee<= 60 characters
RecipientPostalCodeYStringPostal Code of Consignee
To be fill up for those country that use
postal code and default to “” for those
countries that do not use post code.
<= 20 characters
RecipientContactNoYStringContact Number of Consignee<= 20 characters
RecipientEmailNStringEmail Address of Consignee<= 100 characters
CommodityYStringA brief description of the Item.<= 200 characters
OrderNumberNStringA text information that refers to your
order within your internal system, not
required for delivery.
Default to “” if not use.
<= 50 characters
WeightYNumericThe declared weight of the item. If left
blank will default to max weight and
user is liable for corresponding charges.
3 digit decimal place 9.999
LengthNNumericThe length of the item. If left blank will
default to max length and user is liable
for corresponding charges.
2 digit decimal place 9.99
WidthNNumericThe width of the item. If left blank will
default to max width and user is liable
for corresponding charges.
2 digit decimal place 9.99
HeightNNumericThe height of the item.
If left blank will default to max height
and user is liable for corresponding charges.
2 digit decimal place 9.99
DeclaredCurrencyYStringThe declared currency used for the item.
eg. SGD
= 3 characters
DeclaredValueYNumericThe declared value of the item.
eg. 217.50
2 digit decimal place
QtyYNumericNumber of Pieces under the same Tracking Number.Numeric Number
RemarkNStringIf necessary some instruction for the delivery.
Default to "" if blank.
<= 50 characters
ETDNStringEstimated Time of Departure at Origin
eg. 2018-06-14T10:50:00+8:00
Date/Time GMT
Time
ETANStringEstimated Time of Arrival at Destination.
eg. 2018-06-04T15:30:15+8:00
Date/Time GMT
Time
PickUpDateNStringTime to pickup the item at sender location
eg. 2018-06-14T10:50:00+8:00
(for local delivery only)
Date/Time GMT
Time
DeliveryDateNStringDate/Time for delivery of item to consignee
eg. 2018-06-04T15:30:15+8:00
(current not use)
Date/Time GMT
Time
IsDDPNStringDDP="Y", DDU="N", Default "N"= 1 characters
SupplierNameY / NStringThe Supplier Name
Mandatory for destination country Singapore.
Default to “” if not use.
Max 100 Char (Mandatory for Singapore)
GSTRegNoY / NStringThe Supplier GST Registration Number Mandatory for destination country Singapore
Default to “” if not use.
Max 50 Char (Mandatory for Singapore)
GSTAmountY / NNumericThe Amount of Goods and Service Tax Paid.
Mandatory for the destination country Singapore.
Default to “0.00” if not use.
2 digit decimal place (Mandatory for Singapore)
GSTCurrencyY / NStringThe Goods and Services Tax Currency used.
Mandatory for the destination country Singapore.
Default to “” if not use.
Max 3 Char (Mandatory for Singapore)
GSTStatusY / NStringThe status of the Goods and Service Tax Payment.
Mandatory for destination country Singapore.
Eg: “Paid”, default to “” if not use.
Max 5 Char (Mandatory for Singapore)
OriginYStringISO2 Character for Origin Country
Eg. SG for Singapore, TH for Thailand
= 2 characters
DestinationYStringISO2 Character for Destination Country
Eg. SG for Singapore, TH for Thailand
= 2 characters
Dep_IataYStringIATA Airport Code for Origin
Eg. SIN - Singapore Changi Airport
LAX - Los Angeles International Airport
= 3 characters
Arr_IataYStringIATA Airport Code for Destination
Eg. SIN - Singapore Changi Airport
LAX - Los Angeles International Airport
= 3 characters
ItemListingYArray of objectsArray of Item Listing SKU

ItemListing

FieldMandatoryTypeDescriptionLength
SKUNString<= 60 characters
ItemDescriptionYString<= 300 characters
ItemWeightYNumericKG
NoOfPcsYInteger Numeric
ItemValueYNumeric
ItemCurrencyYStringeg: SGD= 3 characters
ItemOriginYStringeg: SG= 2 characters
ItemDestinationYStringeg: TH= 2 characters
HSCodeYStringHS Tariff Code of the Line Item.<= 50 characters

Request

json
{
  "Orders": [
    {
      "OwnerId": 111,
      "ServiceCode": "A0000",
      "MAWBNumber": "PXLUS0000124B000JHDEV",
      "TrackingNumber": "PXLUS0000124B000JHDEV",
      "SendingAgentID": "PXLUS0000124B000JHDEV",
      "SenderName": "iherb",
      "SenderCompany": "",
      "SenderAddress1": "08E Airlines House",
      "SenderAddress2": "",
      "SenderCity": "City",
      "SenderState": "United States",
      "SenderCountry": "Singapore",
      "SenderPostalCode": "238858",
      "SenderContactNo": "",
      "SenderEmail": "",
      "RecipientName": "Somin Jeon",
      "RecipientCompany": "",
      "RecipientAddress1": "Taiwan Taoyuan International Airport",
      "RecipientAddress2": "Hangzhan S Road",
      "RecipientAddress3": "",
      "RecipientCity": "Zhongshan District",
      "RecipientState": "Taipei City",
      "RecipientCountry": "Taiwan",
      "RecipientPostalCode": "51146",
      "RecipientContactNo": "986536",
      "RecipientEmail": "hainn229@gmail.com",
      "Commodity": "Mushrooms",
      "OrderNumber": "",
      "Weight": 1,
      "Length": 10,
      "Width": 10,
      "Height": 10,
      "DeclaredCurrency": "HKD",
      "DeclaredValue": 100,
      "Qty": 2,
      "Remark": "nil",
      "ETD": "2024-02-24 09:00:00",
      "ETA": "2024-02-24 15:00:00",
      "PickUpDate": "",
      "DeliveryDate": "",
      "IsCOD": "N",
      "CODType": 0,
      "CODCurrency": "",
      "CODAmount": 0,
      "SupplierName": "",
      "GSTRegNo": "",
      "GSTAmount": 0,
      "GSTCurrency": "",
      "GSTStatus": "",
      "Origin": "SG",
      "Destination": "TW",
      "Dep_Iata": "SIN",
      "Arr_Iata": "TPE",
      "IsDDP": "Y",
      "ItemListing": [
        {
          "SKU": "222222",
          "ItemDescription": "Mushrooms",
          "ItemWeight": 1,
          "NoOfPcs": 2,
          "ItemValue": 100,
          "ItemCurrency": "HKD",
          "ItemOrigin": "SG",
          "ItemDestination": "TW",
          "HSCode": "482010"
        }
      ]
    }
  ]
}

Response(success)

json
{
  "Code": 0,
  "Message": "Success",
  "Data": {
    "Success": [
      {
        "OwnerId": 1,
        "TrackingNo": "C240129142515376136497",
        "DeliveryId": "",
        "DateTime": "2024-01-29 14:27:06",
        "Status": "Accepted",
        "Error": [
          {
            "Reason": ""
          }
        ]
      },
      {
        "OwnerId": 1,
        "TrackingNo": "C240129142515839830635",
        "DeliveryId": "",
        "DateTime": "2024-01-29 14:27:06",
        "Status": "Accepted",
        "Error": [
          {
            "Reason": ""
          }
        ]
      }
    ],
    "Errors": [
      {
        "OwnerId": 1,
        "TrackingNo": "C240129142514596183997",
        "DeliveryId": "",
        "DateTime": "2024-01-29 14:27:06",
        "Status": "Rejected",
        "Error": [
          {
            "Reason": "The total length of addresses 1, 2, and 3 exceeds the maximum limit of 320 characters"
          }
        ]
      }
    ]
  }
}