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

Create a shipping location

POST
/companies/{companyId}/shippingLocations

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:

  • 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.

Request Body

application/json

address?
contact?

The contact details for the shipping location.

id?string

The unique identifier of the shipping location, for use as shippingLocationId when creating an order.

name?string

The unique name of the shipping location.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/shippingLocations" \  -H "Content-Type: application/json" \  -d '{    "name": "YOUR_COMPANY Rokin depot",    "address": {      "companyName": "YOUR_COMPANY",      "streetAddress": "Rokin 21",      "postalCode": "1012 KS",      "city": "Amsterdam",      "stateOrProvince": "",      "country": "NL"    },    "contact": {      "firstName": "Paul",      "lastName": "Green",      "phoneNumber": "+31 020 1234567",      "email": "Paul.Green@company.com"    }  }'

Example response after creating a shipping location

{  "id": "S2-7973536B20662642215526704F302044452F714622375D476169",  "name": "YOUR_COMPANY Rokin depot",  "contact": {    "firstName": "Paul",    "lastName": "Green",    "phoneNumber": "+31 020 1234567",    "email": "Paul.Green@company.com"  },  "address": {    "companyName": "YOUR_COMPANY",    "streetAddress": "Rokin 21",    "postalCode": "1012 KS",    "city": "Amsterdam",    "stateOrProvince": ""  }}

Get a list of shipping locations GET

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](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).

Get a list of terminal models GET

Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. 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).