Book a pickup for shipments.
POST /pickup
Elements
Request
| Name | Type | Description |
|---|---|---|
| ThirdPartyToken | string | ThirdParty token. Required only for thirdparty collection request. |
| CompanyName | string | Company Name. |
| ContactName | string | Contact name. |
| ContactNumber | string | Contact number. |
| string | Email address. | |
| CarrierCode | string | Shipment carrier code. |
| CollectionDate | string | Collection Date. Format yyyy/MM/dd HH:mm:ss |
| ReadyTime | Object reference PickupRequestReadyTime | Collection ready time. |
| PickupAddress | Object reference PickupRequestAddress | Details of the collection address. |
| ReferenceNumbers | array | A list of reference number. |
| SpecialInstruction | string | Special instruction. |
| ServiceType | string | Service type. |
| GoodsDescription | string | Goods description. |
| NoofItems | number ¹ | Number of shipment. (Optional) Requested if ReferenceNumbers not exist |
| Weight | number ¹ | Total weight. |
| WeightMeasure | string | Weight units. KG,G |
| CubicLength | number ¹ | Cubic length value. |
| CubicWidth | number ¹ | Cubic width value. |
| CubicHeight | number ¹ | Cubic height value. |
| CubicWeight | number ¹ | Cubic weight value. |
| CubicWeightMeasure | string | Cubic weight units. KG,G |
| CubicDimensionMeasure | string | Cubic dimension units. cm,inch |
| SenderRef1 | string | Sender reference 1. |
| SenderRef2 | string | Sender reference 2. |
| SenderRef3 | string | Sender reference 3. |
| RequestVehicle | string | Request vehicle. eg Bike,Van |
| CashValue | number ¹ | Cash collected. |
| NoOfPieces | number ¹ | Number of items/boxes/packages |
| AdditionalInfo | Additional information object | Additional information required by certain integrations only. |
PickupRequestReadyTime
| Name | Type | Description |
|---|---|---|
| StartTime | string | Start time. Format: HH:mm |
| EndTime | string | End time. Format: HH:mm |
PickupRequestAddress
| Name | Type | Description |
|---|---|---|
| Address1 | string | Address line 1. |
| Address2 | string | Address line 2. |
| Address3 | string | Address line 3. |
| AddressState | string | State. |
| AddressCity | string | City |
| AddressPostalCode | string | Postcode. |
| AddressCountryCode | string | Country in ISO Alpha-2 code. |
| AddressLat | number 2 | Address Latitude |
| AddressLng | number 2 | Address Longitude |
Response
| Name | Type | Description |
|---|---|---|
| BookingNumber | string | Collection number. |
| ReferenceNumber | string | Collection reference number. |
| AltRef | string | Shipment alternate reference number. |
| ErrorMsg | string | Error 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"
},
"ReferenceNumbers": ["Ref12345"],
"SpecialInstruction": "fragile shipment. please take care.",
"ServiceType": "EN",
"GoodsDescription": "computer",
"NoofItems": 1,
"Weight": 3,
"WeightMeasure": "KG",
"CubicLength":0,
"CubicWidth":0,
"CubicHeight":0,
"CubicWeight":0,
"CubicWeightMeasure":"KG",
"CubicDimensionMeasure":"cm",
"SenderRef1": "Order0001",
"SenderRef2": "",
"SenderRef3": "",
"RequestVehicle": "",
"CashValue": 0
}
Response
[
{
"BookingNumber": "-160719",
"ErrorMsg": "",
"ReferenceNumber": "Ref12345",
"AltRef": ""
}
]