POST /v1/terminal/locations

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
configuration_overrides String No

The ID of a configuration that will be used to customize all readers in this location.

expand[] Array No

Specifies which fields in the response should be expanded.

display_name String Yes

A name for the location. Maximum length is 1000 characters.

metadata No

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

address Object Yes

The full address of the location.

address.line2 String No
address.line1 String No
address.postal_code String No
address.country String Yes
address.state String No
address.city String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.