1. Home
  2. Developers
  3. Pickup

Pickup

Book a pickup for shipments.

POST /pickup

 

Elements

Request

NameTypeDescription
ThirdPartyTokenstringThirdParty token. Required only for thirdparty collection request.
CompanyNamestringCompany Name.
ContactNamestringContact name.
ContactNumberstringContact number.
EmailstringEmail address.
CarrierCodestringShipment carrier code.
CollectionDatestringCollection Date. Format yyyy/MM/dd HH:mm:ss
ReadyTimeObject reference PickupRequestReadyTimeCollection ready time.
PickupAddressObject reference PickupRequestAddressDetails of the collection address.
ReferenceNumberstringReference number.
SpecialInstructionstringSpecial instruction.
ServiceTypestringService type.
GoodsDescriptionstringGoods description.
NoofItemsnumber ¹Number of items.
Weightnumber ¹Total weight.
WeightMeasurestringWeight unit. KG,G
SenderRef1stringSender reference 1.
SenderRef2stringSender reference 2.
SenderRef3stringSender reference 3.
RequestVehiclestringRequest vehicle. eg Bike,Van
AdditionalInfoAdditional information objectAdditional information required by certain integrations only.

PickupRequestReadyTime

NameTypeDescription
StartTimestringStart time. Format: HH:mm
EndTimestringEnd time. Format: HH:mm

PickupRequestAddress

NameTypeDescription
Address1stringAddress line 1.
Address2stringAddress line 2.
Address3stringAddress line 3.
AddressStatestringState.
AddressCitystringCity
AddressPostalCodestringPostcode.
AddressCountryCodestringCountry in ISO Alpha-2 code.

Response

NameTypeDescription
BookingNumberstringCollection number.
ReferenceNumberstringCollection reference number.
AltRefstringShipment alternate reference number.
ErrorMsgstringError message.

 

Reference

¹ Refer Notes section for required format.

 

Sample

Request

{ "ThirdPartyToken": "", "CompanyName": "Test Company", "ContactName": "Test Contact", "ContactNumber": "01234577890", "Email": "email@email.com", "CarrierCode": "", "CollectionDate": "2019-07-10", "ReadyTime": { "StartTime": "09:00", "EndTime": "18:00" }, "PickupAddress": { "Address1": "address 1", "Address2": "address 2", "Address3": "address 3", "AddressState": "Singapore", "AddressCity": "Singapore", "AddressPostalCode": "208573", "AddressCountryCode": "SG" }, "ReferenceNumber": "Ref12345", "SpecialInstruction": "fragile shipment. please take care.", "ServiceType": "EN", "GoodsDescription": "computer", "NoofItems": "1", "Weight": "3", "WeightMeasure": "kg", "SenderRef1": "Order0001", "SenderRef2": "", "SenderRef3": "", "RequestVehicle": "" }

Response

[ { "BookingNumber": "-160719", "ErrorMsg": "", "ReferenceNumber": "Ref12345", "AltRef": "" } ]