Create a Location

This endpoint allows a Partner user create a Location for a Client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Location to be created.

client
object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

string
required
length ≤ 255

The Location's name.

string
length ≤ 255

A Partner specified reference for a location. Must be unique to a Partner.

string
length ≤ 50

?

string
length ≤ 255

The name of the business at this location.

string
enum
required

The Location's clasification.

string
length ≤ 255

Unique Identifier for the Location.

country
object
required

Reference to the associated Country. When used for POST and PATCH API calls, the reference can contain either the ISO-ALPHA2 country Code or Name.

string
required
length ≤ 255

The Location's street address.

string
length ≤ 255

The Location's street address.

string
required
length ≤ 255

The Location's city.

string
length ≤ 255

The Location's street state or province.

string
length ≤ 10

The Location's postal code.

string

The Location's street address.

string
length ≤ 255

The Location's street address.

string
length ≤ 255

The Location's street address.

string
length ≤ 255

The Location's city.

string
length ≤ 255

The Location's street state or province.

string
length ≤ 10

The Location's postal code.

string

Note for delivery driver.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json