GET /merchants/{merchantId}/shippingLocations

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:

Servers

Path parameters

Name Type Required Description
merchantId String Yes

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.