API Reference
  1. Shipping API
  2. Pickup

Query Pickup Coverage

post
https://rps-sandbox.speedx.io/rps-api/pickup-coverage/zip-codes

This API is primarily used to query the service scope of the pickup function for a specified customer.

Environments

EnvironmentURL
Sandboxhttps://open-sandbox.speedx.io/pus-exchange-api/pickup-coverage/zip-codes
Productionhttps://open.speedx.io/pus-exchange-api/pickup-coverage/zip-codes

Notes


Response Code

CodeCategoryDescription
200SUCCESSSuccess
1000ERRORUnauthorized
2001ERROROperation error
Body Params
string
enum
required
Defaults to PUDO

The bookingCode returned from the Pickup Request API
Either "bookingCode' Or "customerRefId" must be provided.

Allowed:
number
required
Defaults to 1

The customerRefId provided to the Pickup Request API
Either "bookingCode' Or "customerRefId" must be provided.

string

Reason for cancelling the pickup.
Max-length: 255
Example: Shipment delayed

Headers
string
required

API key

Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?