1. Home
  2. Developers
  3. Shipment

Shipment

Upload shipment details to receive a tracking number & to print documentation/labels.

POST /shipments

 

Elements

Request

NameTypeDescription
ThirdPartyTokenstringOptional. 3rdparty account token.
SenderDetailsObject reference SenderDetailsSender information.
ReceiverDetailsObject reference ReceiverDetailsReceiver information.
PackageDetailsObject reference PackageDetailsPackage information.
PickupDetailsObject reference PickupDetailsPickup information.
IntegrationDataAdditional information objectAdditional information required by certain integrations only.

SenderDetails

NameTypeDescription
SenderNamestringSender name.
SenderCompanyNamestringSender company name.
SenderCountryCodestringSender country in ISO Alpha-2 code.
SenderAdd1stringSender address line 1.
SenderAdd2stringSender address line 2.
SenderAdd3stringSender address line 3.
SenderAddCitystringSender city.
SenderAddStatestringSender state.
SenderAddPostcodestringSender postcode.
SenderPhonestringSender phone number.
SenderEmailstringSender email address.
SenderFaxstringSender fax number.
SenderKycTypestringSender KYC document type. eg. Passport
SenderKycNumberstringSender KYC document number.
SenderReceivingCountryTaxIDstringSender Receiving Country Tax ID

ReceiverDetails

NameTypeDescription
ReceiverNamestringReceiver name.
ReceiverCompanyNamestringReceiver company name.
ReceiverCountryCodestringReceiver country in ISO Alpha-2 code.
ReceiverAdd1stringReceiver address line 1.
ReceiverAdd2stringReceiver address line 2.
ReceiverAdd3stringReceiver address line 3.
ReceiverAddCitystringReceiver city.
ReceiverAddStatestringReceiver state.
ReceiverAddPostcodestringReceiver postcode.
ReceiverMobilestringReceiver mobile number.
ReceiverPhonestringReceiver phone number.
ReceiverEmailstringReceiver email address.
ReceiverAddResidentialstringReceiver residential. N - No, Y - Yes
ReceiverFaxstringReceiver fax number.
ReceiverKycTypestringReceiver KYC document type. eg. Passport
ReceiverKycNumberstringReceiver KYC document number.

PackageDetails

NameTypeDescription
GoodDescriptionstringGoods description.
CustomValuenumber ¹ Customs value.
CustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.
InsuranceValuenumber ¹ Insurance value.
InsuranceCurrencyCodestringInsurance currency in ISO 4217 3-Letter code.
ShipmentTermstringShipment terms. DDU,DDP
GoodsOriginCountryCodestringGoods origin country in ISO Alpha-2 code.
DeliveryInstructionsstringDelivery instructions.
Weightnumber ¹ Charged weight value.
WeightMeasurementstringWeight units. KG,LBS
NoOfItemsnumber ¹ Number of items. Default: 1
CubicLnumber ¹ Cubic length value.
CubicWnumber ¹ Cubic width value.
CubicHnumber ¹ Cubic height value.
CubicWeightnumber ¹ Cubic weight value.
CubicWeightMeasurementstringCubic weight units. KG,LBS
ServiceTypeNamestringService type code.
BookPickUPbooleanBook a pickup. true,false
AlternateRefstringAlternate reference number.
SenderRef1stringSender reference number 1.
SenderRef2stringSender reference number 2.
SenderRef3stringSender reference number 3.
ShipmentResponseItemarray of ShipmentResponseItemA list shipment items.
CODAmountnumber ¹ COD value.
CODCurrencyCodestringCOD currency in ISO 4217 3-Letter code.
Bagnumber ¹ Number of bag. Default: 0
NotesstringShipment notes.
OriginLocCodestringOrigin location in International Air Transport Association (IATA) code.
BagNumberstringBag reference number in which shipment is placed.
DeadWeightnumber ¹ Actual weight value.
ReasonExportstringReason for export.
DestTaxesnumber ¹ Destination tax value.
Securitynumber ¹ Security value.
Surchargenumber ¹ Surcharge value.
ReceiverTaxIDstringReceiver tax ID.
IncotermsstringPackage incoterms. CIF,CFR,FOB
ClearanceReferencestringImport Export Code.

PickupDetails

NameTypeDescription
ReadyTimestringPickup ready time in country local time zone. Format: yyyy/MM/dd HH:mm:ss
CloseTimestringPickup close time in country local time zone. Format: yyyy/MM/dd HH:mm:ss
SpecialInstructionsstringSpecial instructions.

ShipmentResponseItem

NameTypeDescription
ItemAltstringAlternate reference.
ItemNoOfPcsstringNumber of piece. Default: 1
ItemCubicLnumber ¹Cubic length value in cm.
ItemCubicWnumber ¹Cubic width value in cm.
ItemCubicHnumber ¹Cubic height value in cm.
ItemWeightnumber ¹Weight value.
ItemCubicWeightnumber ¹Cubic weight value.
ItemCubicWeightMeasurementstringCubic weight units. KG,G,LBS
ItemDescriptionstringDescription.
ItemCustomValuenumber ¹Customs value.
ItemCustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.
NotesstringItem notes.
Piecesarray of PiecesA list pieces.
ItemHarmonisedCodestringHarmonised code

Pieces

NameTypeDescription
Weightnumber ¹Cubic weight value.
Quantitynumber ¹Number of piece. Default: 1
HarmonisedCodestringHarmonised code.
GoodsDescriptionstringDescription.
ContentstringContent of the item.
NotesstringItem notes.
SenderRef1stringReference number.
ManufactureCountryCodestringManufacture country code in ISO Alpha-2 code.
OriginCountryCodestringOrigin country code in ISO Alpha-2 code.
CurrencyCodestringCustoms currency in ISO 4217 3-Letter code.
CustomsValuenumber ¹Customs value.

Response

Array of Shipment Response

NameTypeDescription
ShipmentNumberstringShipment Number.
SenderRefstringSender reference number.
JobRefnumberJob reference number. Applicable if BookPickup set to true
AccessIDstringN/A
AcccountCodestringAccount code.
LabelURLstringLabel URL.
ErrMessagestringError message.

 

Reference

¹ Refer Notes section for required format.

 

Sample

Request

[{ "ThirdPartyToken":"", "SenderDetails": { "SenderName": "John", "SenderCompanyName": "ABC Pte Ltd", "SenderCountryCode": "SG", "SenderAdd1": "338D King George's Avenue", "SenderAdd2": "King George Building", "SenderAdd3": "", "SenderAddCity": "", "SenderAddState": "", "SenderAddPostcode": "208573", "SenderPhone": "99999999", "SenderEmail": "abc@abc.com", "SenderFax": "", "SenderKycType":"Passport", "SenderKycNumber":"P00001", "SenderReceivingCountryTaxID":"" }, "ReceiverDetails": { "ReceiverName": "May", "ReceiverCompanyName": "ABC Pte Ltd", "ReceiverCountryCode": "MY", "ReceiverAdd1": "Avenue Business Centre", "ReceiverAdd2": "Suite 6.1", "ReceiverAdd3": "", "ReceiverAddCity": "Puchong", "ReceiverAddState": "Selangor", "ReceiverAddPostcode": "123456", "ReceiverMobile": "01699999999", "ReceiverPhone": "0399999999", "ReceiverEmail": "abc@abc.com", "ReceiverAddResidential": "N", "ReceiverFax": "", "ReceiverKycType":"Passport", "ReceiverKycNumber":"P00005" }, "PackageDetails": { "GoodDescription": "a box of shirts", "CustomValue": 3.00, "CustomCurrencyCode": "SGD", "InsuranceValue": "0.00", "InsuranceCurrencyCode": "SGD", "ShipmentTerm": "", "GoodsOriginCountryCode": "SG", "DeliveryInstructions": "fragile shipment. please take care.", "Weight": 3, "WeightMeasurement": "KG", "NoOfItems": 1, "CubicL": 3, "CubicW": 3, "CubicH": 3, "CubicWeight": 0.0, "CubicWeightMeasurement": "KG", "ServiceTypeName": "EN", "BookPickUP": false, "AlternateRef": "", "SenderRef1": "test shipment", "SenderRef2": "", "SenderRef3": "", "ShipmentResponseItem": [{ "ItemAlt": "", "ItemNoOfPcs": 1, "ItemCubicL": 3, "ItemCubicW": 3, "ItemCubicH": 3, "ItemWeight": 3, "ItemCubicWeight": 0, "ItemCubicWeightMeasurement": "1", "ItemDescription": "document", "ItemCustomValue": 3.00, "ItemCustomCurrencyCode": "SGD", "Notes": "item notes", "Pieces":[{ "HarmonisedCode":"hs001", "GoodsDescription":"shirts", "Content":"cotton", "Notes": "shirts", "SenderRef1":"ref #001", "Quantity":3, "Weight":3, "ManufactureCountryCode":"SG", "OriginCountryCode":"SG", "CurrencyCode":"SGD", "CustomsValue":3.00 }] }], "CODAmount": 0.0, "CODCurrencyCode": "SGD", "Bag": 0, "Notes": "this is sample notes", "OriginLocCode": "", "BagNumber": 0, "DeadWeight": 3, "ReasonExport": "", "DestTaxes": 0.0, "Security": 0.0, "Surcharge": 0.0, "ReceiverTaxID": "", "OrderNumber": "", "Incoterms":"CIF", "ClearanceReference":"" }, "PickupDetails": { "ReadyTime": "2019/03/12 12:00:00", "CloseTime": "2019/03/12 15:00:00", "SpecialInstructions": "test" } }]

Response

[ { "ShipmentNumber": "CT1294823210", "SenderRef": "test shipment", "JobRef": "-4391", "AccessID": "", "AcccountCode": "", "LabelURL": "https://ws01.ffdx.net/v4/printdoc/docConnoteStyle2.aspx?accessid=TEST&shipno=CT1294823210&format=pdf", "ErrMessage": "" } ]