1. Home
  2. Developers
  3. Shipment

Shipment

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

POST /shipments

 

Elements

Request

NameTypeDescriptionAttributes
ThirdPartyTokenstringAccount Token.Optional
SenderDetailsObject reference SenderDetailsSender information.Mandatory
ReceiverDetailsObject reference ReceiverDetailsReceiver information.Mandatory
PackageDetailsObject reference PackageDetailsPackage information.Mandatory
PickupDetailsObject reference PickupDetailsPickup information.Mandatory
IntegrationDataAdditional information objectAdditional information required by certain integrations only.Mandatory

SenderDetails

NameTypeDescriptionAttributes
SenderNamestringSender name.Mandatory
SenderCompanyNamestringSender company name.Mandatory
SenderCountryCodestringSender country in ISO Alpha-2 code.Mandatory
SenderAdd1stringSender address line 1.Mandatory
SenderAdd2stringSender address line 2.Optional
SenderAdd3stringSender address line 3.Optional
SenderAddCitystringSender city.Mandatory
SenderAddStatestringSender state.Optional
SenderAddPostcodestringSender postcode.Mandatory
SenderPhonestringSender phone number.Mandatory
SenderEmailstringSender email address.Optional
SenderFaxstringSender fax number.Optional
SenderKycTypestringSender KYC document type. eg. PassportOptional
SenderKycNumberstringSender KYC document number.Optional
SenderReceivingCountryTaxIDstringSender Receiving Country Tax IDOptional
SenderAddressGeoLatnumber 2Sender Address LatitudeOptional
SenderAddressGeoLngnumber 2Sender Address LongitudeOptional
SenderTaxIDstringSender Tax IDOptional

ReceiverDetails

NameTypeDescriptionAttributes
ReceiverNamestringReceiver name.Mandatory
ReceiverCompanyNamestringReceiver company name.Mandatory
ReceiverCountryCodestringReceiver country in ISO Alpha-2 code.Mandatory
ReceiverAdd1stringReceiver address line 1.Mandatory
ReceiverAdd2stringReceiver address line 2.Optional
ReceiverAdd3stringReceiver address line 3.Optional
ReceiverAddCitystringReceiver city.Mandatory
ReceiverAddStatestringReceiver state.Optional
ReceiverAddPostcodestringReceiver postcode.Mandatory
ReceiverMobilestringReceiver mobile number.Optional
ReceiverPhonestringReceiver phone number.Mandatory
ReceiverEmailstringReceiver email address.Optional
ReceiverAddResidentialstringReceiver residential. N - No, Y - YesOptional
ReceiverFaxstringReceiver fax number.Optional
ReceiverKycTypestringReceiver KYC document type. eg. PassportOptional
ReceiverKycNumberstringReceiver KYC document number.Optional
ReceiverAddressGeoLatnumber 2Receiver Address LatitudeOptional
ReceiverAddressGeoLngnumber 2Receiver Address LongitudeOptional

PackageDetails

NameTypeDescriptionAttributes
GoodDescriptionstringGoods description.Optional
CustomValuenumber ¹ Customs value. Mandatory
CustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.Mandatory
InsuranceValuenumber ¹ Insurance value. Optional
InsuranceCurrencyCodestringInsurance currency in ISO 4217 3-Letter code.Optional
ShipmentTermstringShipment terms. DDU,DDPOptional
GoodsOriginCountryCodestringGoods origin country in ISO Alpha-2 code.Mandatory
DeliveryInstructionsstringDelivery instructions.Optional
Weightnumber ¹ Charged weight value. Mandatory
WeightMeasurementstringWeight units. G,KG,LBSMandatory
NoOfItemsnumber ¹ Number of items. Default: 1 Mandatory
CubicLnumber ¹ Cubic length value. Mandatory
CubicWnumber ¹ Cubic width value.Mandatory
CubicHnumber ¹ Cubic height value. Mandatory
CubicWeightnumber ¹ Cubic weight value.Mandatory
ServiceTypeNamestringService type code.Mandatory
BookPickUPbooleanBook a pickup. true,falseOptional
AlternateRefstringAlternate reference number.Optional
SenderRef1stringSender reference number 1.Optional
SenderRef2stringSender reference number 2.Optional
SenderRef3stringSender reference number 3.Optional
ShipmentResponseItemarray of ShipmentResponseItemA list shipment items.Optional
CODAmountnumber ¹ COD value. Optional
CODCurrencyCodestringCOD currency in ISO 4217 3-Letter code.Optional
Bagnumber ¹ Number of bag. Default: 0Optional
NotesstringShipment notes.Optional
OriginLocCodestringOrigin location in International Air Transport Association (IATA) code.Optional
BagNumberstringBag reference number in which shipment is placed.Optional
DeadWeightnumber ¹ Actual weight value. Mandatory
ReasonExportstringReason for export.Optional
DestTaxesnumber ¹ Destination tax value. Optional
Securitynumber ¹ Security value.Optional
Surchargenumber ¹ Surcharge value. Optional
ReceiverTaxIDstringReceiver tax ID.Optional
IncotermsstringPackage incoterms. CIF,CFR,FOBOptional
ClearanceReferencestringImport Export Code.Optional
DeliveryAgentCodestringDelivery Agent CodeOptional
DeliveryRouteCodestringDelivery Route CodeOptional
CPCCodestringCPC CodeOptional
SKUNumberstringSKU NumberOptional
ATENumberstringATE NumberOptional
ProductURL stringProduct URLOptional
GoodsValuenumber ¹Goods ValueOptional
GoodsCurrencyCode stringGoods Currency CodeOptional
DutyValuenumber ¹Duty ValueOptional
DutyCurrencyCode stringDuty Currency CodeOptional
EORINumber stringEOR NumberOptional
HarmonisedCodestringHarmonised CodeOptional
TotalGSTAmountnumber ¹GST ValueOptional
TotalGSTCurrencyCodestringGST Currency CodeOptional
FreightCostnumber ¹Freight CostOptional
FreightCostCurrencyCodestringFreight Currency CodeOptional

PickupDetails

NameTypeDescriptionAttributes
ReadyTimestringPickup ready time in country local time zone. Format: yyyy/MM/dd HH:mm:ssOptional
CloseTimestringPickup close time in country local time zone. Format: yyyy/MM/dd HH:mm:ssOptional
SpecialInstructionsstringSpecial instructions.Optional
Address1stringPickup address line 1Optional
Address2stringPickup address line 2Optional
Address3stringPickup address line 3Optional
AddressStatestringPickup stateOptional
AddressCitystringPickup cityOptional
AddressPostalCodestringPickup postcodeOptional
AddressCountryCodestringPickup country in ISO Alpha-2 codeOptional

ShipmentResponseItem

NameTypeDescriptionAttributes
ItemAltstringAlternate reference.Optional
ItemNoOfPcsstringNumber of piece. Default: 1Optional
ItemCubicLnumber ¹Cubic length value in cm.Mandatory
ItemCubicWnumber ¹Cubic width value in cm.Mandatory
ItemCubicHnumber ¹Cubic height value in cm.Mandatory
ItemWeightnumber ¹Weight value.Mandatory
ItemCubicWeightnumber ¹Cubic weight value.Mandatory
ItemDescriptionstringDescription.Optional
ItemCustomValuenumber ¹Customs value.Mandatory
ItemCustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.Mandatory
NotesstringItem notes.Mandatory
Piecesarray of PiecesA list pieces.Optional
ItemHarmonisedCodestringHarmonised codeOptional
ItemDeadWeight numberItem Dead Weight Mandatory
ItemGoodsOriginCountryCodestringOrigin Country CodeMandatory

Pieces

NameTypeDescriptionAttributes
Weightnumber ¹Weight value.Mandatory
Quantitynumber ¹Number of piece. Default: 1Optional
HarmonisedCodestringHarmonised code.Optional
GoodsDescriptionstringDescription.Optional
ContentstringContent of the item.Optional
NotesstringItem notes.Optional
SenderRef1stringReference number.Optional
ManufactureCountryCodestringManufacture country code in ISO Alpha-2 code.Mandatory
OriginCountryCodestringOrigin country code in ISO Alpha-2 code.Mandatory
CurrencyCodestringCustoms currency in ISO 4217 3-Letter code.Mandatory
CustomsValuenumber ¹Customs value.Mandatory
DeadWeight numberDead Weight Mandatory
ReferencestringPiece Ref or SKU NumberMandatory
ATENumberstringATE Number Optional
CPCCodestringCPC CodeOptional
ProductURL stringProduct URL Optional
GoodsValuenumber ¹Goods Value Optional
GoodsCurrencyCode stringGoods Currency Code Optional
DutyValuenumber ¹Duty ValueOptional
DutyCurrencyCode stringDutyCurrencyCodeOptional
GSTValuenumber ¹GST ValueOptional
GSTCurrencyCode stringGST Currency Code Optional

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.
AlternateRef stringAlternate Reference
AdditionalLabelarray of AdditionalLabelA list of Additional Label

AdditionalLabel

NameTypeDescription
LabelNamestringLabel Name
LabelFormatstringLabel format.
Eg:PDF
LabelURLstringLabel URL

 

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, "ServiceTypeName": "EN", "BookPickUP": false, "AlternateRef": "", "SenderRef1": "test shipment", "SenderRef2": "", "SenderRef3": "", "DeliveryAgentCode": "", "DeliveryRouteCode": "", "ShipmentResponseItem": [{ "ItemAlt": "", "ItemNoOfPcs": 1, "ItemCubicL": 3, "ItemCubicW": 3, "ItemCubicH": 3, "ItemWeight": 3, "ItemCubicWeight": 0, "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", "Address1": "address 1", "Address2": "address 2", "Address3": "address 3", "AddressState": "Singapore", "AddressCity": "Singapore", "AddressPostalCode": "208573", "AddressCountryCode": "SG" } }]

Response

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