POST
/locationsList Locations
This endpoint retrieves a list of list locations. Use the available filters and pagination parameters to refine your results.
POST
/locationsMandatory Fields
- body
- pickupLocation
Note
For any technical assistance or feature requests, please contact our API support team.
Important Notes
- Always use HTTPS for API requests.
- Access tokens are valid for a limited time and should be refreshed periodically.
- Rate limiting applies to all endpoints to ensure system stability.
Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | object | Required | none |
ยป pickupLocation | body | string | Required | Search query for locations |
- All parameters should be formatted according to the types specified in the table above.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Authorization Failed | None |
| 429 | Too Many Requests | Too Many Requests | None |
| 500 | Internal Server Error | Internal Server Error | None |
Response Notes
The response will include a status field indicating success or failure, along with the requested data or relevant error messages. Standard HTTP status codes are used to indicate the outcome of the request.
Example Request
# You can also use wget
curl -X POST /locations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{"pickupLocation":"string"}'
Body parameter
{
"pickupLocation": "New Jersey"
}
Example responses
200 Response
[
{
"pickupLocation": "New Jersey",
"websiteCode": 1,
"countryCode": "US"
}
]
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.