v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminal orders - merchant level

Get a list of shipping locations

Returns the shipping locations for the merchant account identified in the path. 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/merchants/{merchantId}/shippingLocations

Path parameters

merchantIdstring required

The unique identifier of the merchant 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.