Terminal orders - company level
Get a list of shipping locations
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
In the live environment, requests to this endpoint are subject to rate limits.
get/companies/{companyId}/shippingLocations
Path parameters
companyIdstring required
The unique identifier of the company account.
Query parameters
namestring
The name of the shipping location.
offsetinteger
The number of locations to skip.
limitinteger
The number of locations to return.
Response
OK - the request has succeeded.