Pickup
Pickup Object
| Attributes |
Definitions |
| carrierCode |
FDXG,FDXE |
| packageCount |
Number of packages |
| massUnit |
lbs,kgs |
| senderName |
Name of the person |
| senderCompany |
Name of the organization |
| senderCountryCode |
ISO 3166-1-alpha-2 code (ISO 2 country code) |
| senderStateCode |
Only accept two-character state abbreviations |
| senderZipCode |
ZIP or postal code the address is located in |
| senderCity |
City the address is located in |
| senderAddressLine1 |
First line of the address |
| senderAddressLine2 |
Second line of the address |
| senderPhone |
Phone number to reach the person or organization |
| packageLocation |
FRONT,SIDE,REAR,NONE |
| buildingPart |
APARTMENT,BUILDING,DEPARTMENT,FLOOR,ROOM,SUITE |
| buildingPartDescription |
Description |
| note |
Note |
| readyTimestamp |
The earliest time to pick up the goods |
| latestPickupDateTime |
The latest time you can pick up the goods |
Pickup Response
| Attributes |
Definitions |
| result |
Values are: OK, ERR. |
| data |
You need to provide it when canceling |
| message |
If there is an error, an error message will be returned. |
Apply for pickup
Apply for pickup
endpoint : https://ezeeship.com/api/ezeeship-openapi/pickUp/applyPickUp
Pickup sample
POST : https://ezeeship.com/api/ezeeship-openapi/pickUp/applyPickUp
{
"carrierCode": "FDXG",
"packageCount": 1,
"totalWeight": 1,
"massUnit": "lbs",
"senderName": "test",
"senderCompany": "International Trading Company",
"senderAddressLine1": "4342 Coolidge Ave",
"senderAddressLine2": "",
"senderCountryCode": "US",
"senderStateCode": "CA",
"senderCity": "Los Angeles",
"senderZipCode": "90066",
"senderPhone": "9999999999",
"packageLocation": "FRONT",
"buildingPart": "BUILDING",
"buildingPartDescription":"test",
"note": "test remark",
"readyTimestamp": "2021-12-02 07:00:00",
"latestPickupDateTime": "2021-12-02 20:00:00"
}
Response :
{
"result": "OK",
"errorCode": null,
"message": "",
"zhMessage": null,
"errorType": null,
"data": 1
}
Cancel Pickup
To cancel pick up, you need to provide the ID returned when applying
POST : https://ezeeship.com/api/ezeeship-openapi/pickUp/pickupCancel?id=xxxx
Response :
{
"result": "OK",
"message": ""
}
Query Pickup
| Attributes |
Definitions |
| confirmationNumber |
Pickup confirmation number |
| status |
1.success 2.error 3.cancel 4.other |
| message |
If there is an error, an error message will be returned. |
GET : https://ezeeship.com/api/ezeeship-openapi/pickUp/queryPickupInfoList?startDate=2021-12-01 08:00:00&endDate=2021-12-03 07:59:59&curPageNo=1&pageSize=20
Response :
{
"defaultPageNo": 1,
"pageSize": 20,
"pageNo": 1,
"totalCount": "1",
"totalPage": 1,
"datas": [
{
"senderName": "test",
"senderCompany": "International Trading Company",
"senderPhone": "9999999999",
"senderAddressLine1": "4342 Coolidge Ave",
"senderAddressLine2": ""
"senderCountryCode": "US",
"senderStateCode": "CA",
"senderCity": "Los Angeles",
"senderZipCode": "90066",
"buildingPart": "BUILDING",
"packageLocation": "FRONT",
"packageCount": 1,
"totalWeight": 1.00,
"carrierCode": "FDXG",
"readyTimestamp": "2021-12-02 07:00:00",
"latestPickupDateTime": "2021-12-02 20:00:00",
"confirmationNumber": "CPU4449413350",
"message": "Success",
"status": 3,
"note": "test remark",
"massUnit": "lbs",
}
]
}