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

Create a shipping location

POST
/merchants/{merchantId}/shippingLocations

Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to.

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

merchantId*string

The unique identifier of the merchant 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/merchants/string/shippingLocations" \  -H "Content-Type: application/json" \  -d '{    "name": "YOUR_MERCHANT_ACCOUNT Barcelona depot",    "address": {      "companyName": "YOUR_COMPANY",      "streetAddress": "El quinto pino 42",      "postalCode": "08012",      "city": "Barcelona",      "stateOrProvince": "",      "country": "ES"    },    "contact": {      "firstName": "Rita",      "lastName": "Perengano",      "phoneNumber": "+34 93 1234567",      "email": "Rita.Perengano@company.com"    }  }'

Example response after creating a shipping location

{  "id": "S2-73536B20665526704F30792642212044452F714622375D477270",  "name": "YOUR_MERCHANT_ACCOUNT Barcelona depot",  "contact": {    "firstName": "Rita",    "lastName": "Perengano",    "phoneNumber": "+34931234567",    "email": "Rita.Perengano@company.com"  },  "address": {    "companyName": "YOUR_COMPANY",    "streetAddress": "El quinto pino 42",    "postalCode": "08012",    "city": "Barcelona",    "stateOrProvince": ""  }}

Get a list of shipping locations GET

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](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 the payment terminal models that the merchant account 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).