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

NameTypeDescriptionAttributesLength
SenderNamestringSender name.Mandatory40
SenderCompanyNamestringSender company name.Mandatory100
SenderCountryCodestringSender country in ISO Alpha-2 code.Mandatory2
SenderAdd1stringSender address line 1.Mandatory75
SenderAdd2stringSender address line 2.Optional75
SenderAdd3stringSender address line 3.Optional75
SenderAddCitystringSender city.Mandatory50
SenderAddStatestringSender state.Optional50
SenderAddPostcodestringSender postcode.Mandatory50
SenderPhonestringSender phone number.Mandatory20
SenderEmailstringSender email address.Optional200
SenderFaxstringSender fax number.Optional20
SenderKycTypestringSender KYC document type. eg. PassportOptional200
SenderKycNumberstringSender KYC document number.Optional200
SenderReceivingCountryTaxIDstringSender Receiving Country Tax IDOptional100
SenderAddressGeoLatnumber 2Sender Address LatitudeOptional
SenderAddressGeoLngnumber 2Sender Address LongitudeOptional
SenderTaxIDstringSender Tax IDOptional50

ReceiverDetails

NameTypeDescriptionAttributesLength
ReceiverNamestringReceiver name.Mandatory40
ReceiverCompanyNamestringReceiver company name.Mandatory100
ReceiverCountryCodestringReceiver country in ISO Alpha-2 code.Mandatory2
ReceiverAdd1stringReceiver address line 1.Mandatory75
ReceiverAdd2stringReceiver address line 2.Optional75
ReceiverAdd3stringReceiver address line 3.Optional75
ReceiverAddCitystringReceiver city.Mandatory50
ReceiverAddStatestringReceiver state.Optional50
ReceiverAddPostcodestringReceiver postcode.Mandatory50
ReceiverMobilestringReceiver mobile number.Optional20
ReceiverPhonestringReceiver phone number.Mandatory20
ReceiverEmailstringReceiver email address.Optional200
ReceiverAddResidentialstringReceiver residential. N - No, Y - YesOptional1
ReceiverFaxstringReceiver fax number.Optional20
ReceiverKycTypestringReceiver KYC document type. eg. PassportOptional200
ReceiverKycNumberstringReceiver KYC document number.Optional200
ReceiverAddressGeoLatnumber 2Receiver Address LatitudeOptional
ReceiverAddressGeoLngnumber 2Receiver Address LongitudeOptional

PackageDetails

NameTypeDescriptionAttributesLength
GoodDescriptionstringGoods description.Optional200
CustomValuenumber ¹ Customs value. Mandatory
CustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.Mandatory3
InsuranceValuenumber ¹ Insurance value. Optional
InsuranceCurrencyCodestringInsurance currency in ISO 4217 3-Letter code.Optional3
ShipmentTermstringShipment terms. DDU,DDPOptional3
GoodsOriginCountryCodestringGoods origin country in ISO Alpha-2 code.Mandatory2
DeliveryInstructionsstringDelivery instructions.Optional200
Weightnumber ¹ Charged weight value. Mandatory
WeightMeasurementstringWeight units. G,KG,LBSMandatory3
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.Mandatory10
BookPickUPbooleanBook a pickup. true,falseOptional
AlternateRefstringAlternate reference number.Optional50
SenderRef1stringSender reference number 1.Optional50
SenderRef2stringSender reference number 2.Optional50
SenderRef3stringSender reference number 3.Optional50
ShipmentResponseItemarray of ShipmentResponseItemA list shipment items.Optional
CODAmountnumber ¹ COD value. Optional
CODCurrencyCodestringCOD currency in ISO 4217 3-Letter code.Optional3
Bagnumber ¹ Number of bag. Default: 0Optional
NotesstringShipment notes.Optional200
OriginLocCodestringOrigin location in International Air Transport Association (IATA) code.Optional5
BagNumberstringBag reference number in which shipment is placed.Optional10
DeadWeightnumber ¹ Actual weight value. Mandatory
ReasonExportstringReason for export.Optional200
DestTaxesnumber ¹ Destination tax value. Optional50
Securitynumber ¹ Security value.Optional
Surchargenumber ¹ Surcharge value. Optional
ReceiverTaxIDstringReceiver tax ID.Optional50
IncotermsstringPackage incoterms. CIF,CFR,FOBOptional3
ClearanceReferencestringImport Export Code.Optional20
DeliveryAgentCodestringDelivery Agent CodeOptional20
DeliveryRouteCodestringDelivery Route CodeOptional100
CPCCodestringCPC CodeOptional50
SKUNumberstringSKU NumberOptional50
ATENumberstringATE NumberOptional50
ProductURL stringProduct URLOptional200
GoodsValuenumber ¹Goods ValueOptional
GoodsCurrencyCode stringGoods Currency CodeOptional3
DutyValuenumber ¹Duty ValueOptional
DutyCurrencyCode stringDuty Currency CodeOptional3
EORINumber stringEOR NumberOptional50
HarmonisedCodestringHarmonised CodeOptional50
TotalGSTAmountnumber ¹GST ValueOptional
TotalGSTCurrencyCodestringGST Currency CodeOptional3
FreightCostnumber ¹Freight CostOptional
FreightCostCurrencyCodestringFreight Currency CodeOptional3

PickupDetails

NameTypeDescriptionAttributesLength
ReadyTimestringPickup ready time in country local time zone. Format: yyyy/MM/dd HH:mm:ssOptional19
CloseTimestringPickup close time in country local time zone. Format: yyyy/MM/dd HH:mm:ssOptional19
SpecialInstructionsstringSpecial instructions.Optional200
Address1stringPickup address line 1Optional75
Address2stringPickup address line 2Optional75
Address3stringPickup address line 3Optional75
AddressStatestringPickup stateOptional50
AddressCitystringPickup cityOptional50
AddressPostalCodestringPickup postcodeOptional50
AddressCountryCodestringPickup country in ISO Alpha-2 codeOptional2

ShipmentResponseItem

NameTypeDescriptionAttributesLength
ItemAltstringAlternate reference.Optional50
ItemNoOfPcsnumber ¹Number 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.Optional200
ItemCustomValuenumber ¹Customs value.Mandatory
ItemCustomCurrencyCodestringCustoms currency in ISO 4217 3-Letter code.Mandatory3
NotesstringItem notes.Mandatory200
Piecesarray of PiecesA list pieces.Optional
ItemHarmonisedCodestringHarmonised codeOptional50
ItemDeadWeight numberItem Dead Weight Mandatory
ItemGoodsOriginCountryCodestringOrigin Country CodeMandatory2

Pieces

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

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": "" }] }]