GET /companies/{companyId}/shippingLocations
Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.
To make this request, your API credential must have one of the following roles:
- Management API—Terminal ordering read
- Management API—Terminal ordering read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The name of the shipping location. |
limit |
Integer | No |
The number of locations to return. |
offset |
Integer | No |
The number of locations to skip. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.