APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal ordersTerminal orders company level

Get a list of shipping locations

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

In the live environment, requests to this endpoint are subject to rate limits.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

Query Parameters

name?string

The name of the shipping location.

offset?integer

The number of locations to skip.

Formatint32
limit?integer

The number of locations to return.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/shippingLocations"

Example response with shipping locations for a company

{  "data": [    {      "id": "S2-232A6D2967356F424F4369432B3F486B6A6D",      "name": "YOUR_COMPANY HQ - POS Ops",      "contact": {        "firstName": "Paul",        "lastName": "Green",        "email": "Paul.Green@company.com"      },      "address": {        "streetAddress": "Simon Carmiggeltstraat",        "streetAddress2": "6-50",        "postalCode": "1011 DJ",        "city": "Amsterdam",        "country": "NL"      }    },    {      "id": "S2-6A6C2E3432747D4F2F2C3455485E3836457D",      "name": "YOUR_COMPANY Spain",      "contact": {        "firstName": "Pablo",        "lastName": "Mengano",        "phoneNumber": "+34911234567",        "email": "Pablo.Mengano@company.com"      },      "address": {        "streetAddress": "Paseo de la Castellana 43",        "streetAddress2": "7 piso",        "postalCode": "28046",        "city": "Madrid",        "country": "ES"      }    }  ]}

Get a list of billing entities GET

Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * 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](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).

Create a shipping location POST

Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).