post
https://rps-sandbox.speedx.io/rps-api/pickup/create
This API will create a pickup request
Environments
| Environment | URL |
|---|---|
| Sandbox | https://rps-sandbox.speedx.io/rps-api/pickup/create |
| Production | https://rps.speedx.io/rps-api/pickup/create |
Notes
- Fields marked as Required are essential for certain services. Ensure the correct fields are included by checking the "Required" column in each section.
- Many field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.
Response Code
| Code | Category | Description |
|---|---|---|
| 200 | SUCCESS | Success |
| 603 | ERROR | Account config error |
| 1000 | ERROR | Unauthorized |
| 2000 | ERROR | Pickup address is not in coverage |
| 2001 | ERROR | Operation error |
| 2002 | ERROR | The gross weight is less than the minimum requirement |
| 2003 | ERROR | The total parcel quantity is less than the minimum requirement |
| 2004 | ERROR | The pickup time window is not supported |
| 2005 | ERROR | Invalid tracking number list |
| 2006 | ERROR | CustomerRefId already exists |
Response Parcel Error Code
| Code | Category | Description |
|---|---|---|
| CPS-001 | ERROR | Parcel not found |
| CPS-002 | ERROR | Parcel is duplicate |
| CPS-003 | ERROR | Invalid parcel for this account |