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
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
The unique identifier of the company account. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The unique identifier of the shipping location, for use as |
contact |
Object | No |
The contact details for the shipping location. |
contact.email |
String | No |
The individual's email address. |
contact.lastName |
String | No |
The individual's last name. |
contact.phoneNumber |
String | No |
The individual's phone number, specified as 10-14 digits with an optional |
contact.firstName |
String | No |
The individual's first name. |
contact.infix |
String | No |
The infix in the individual's name, if any. |
name |
String | No |
The unique name of the shipping location. |
address |
Object | No |
The address details of the shipping location. |
address.companyName |
String | No |
The name of the company. |
address.postalCode |
String | No |
The postal code. |
address.streetAddress |
String | No |
The name of the street, and the house or building number. |
address.stateOrProvince |
String | No |
The state or province as defined in ISO 3166-2. For example, ON for Ontario, Canada. Applicable for the following countries:
|
address.country |
String | No |
The two-letter country code, in ISO 3166-1 alpha-2 format. |
address.city |
String | No |
The name of the city. |
address.streetAddress2 |
String | No |
Additional address details, if any. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.