Get a list of shipping locations

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:

  • Management API—Terminal ordering read
  • Management API—Terminal ordering read and write
Endpoint destination URL
https://management-test.adyen.com/v1/merchants/{merchantId}/shippingLocations
Click to copy

Query Parameters

limitinteger

The number of locations to return.

offsetinteger

The number of locations to skip.

namestring

The name of the shipping location.

Path Parameters

merchantIdstringRequired

The unique identifier of the merchant account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less