v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminal orders - company level

Create a shipping location

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.

post/companies/{companyId}/shippingLocations

Path parameters

companyIdstring required

The unique identifier of the company account.

Request body

idstring

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

namestring

The unique name of the shipping location.

Response

OK - the request has succeeded.

idstring

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

namestring

The unique name of the shipping location.