Create Location

Creates a new Location using the parameters passed in the request.

SecurityOAuth2.0
Request
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Request Body schema: application/json
optional
location_code
string
location_name
required
string
contact_name
required
string
contact_email
string

Conditionally mandatory based on Account Settings

contact_phone
string

Conditionally mandatory based on Account Settings

alternate_phone
string
address1
required
string
address2
string
city
required
string
state
string
postcode
string
country
required
string
coords
string
what3words
string
type
string
Enum: "business" "residential"
shopify_location_id
string
deleted
boolean
merchants
Array of strings
Responses
201
post/locations
Request samples
application/json
{
  • "location_code": "string",
  • "location_name": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_phone": "string",
  • "alternate_phone": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postcode": "string",
  • "country": "string",
  • "coords": "string",
  • "what3words": "string",
  • "type": "business",
  • "shopify_location_id": "string",
  • "deleted": true,
  • "merchants": [
    ]
}
Response samples
application/json
{
  • "location_id": "string",
  • "location_code": "string",
  • "location_name": "string",
  • "contact_name": "string",
  • "contact_email": "string",
  • "contact_phone": "string",
  • "alternate_phone": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postcode": "string",
  • "country": "string",
  • "coords": "string",
  • "what3words": "string",
  • "type": "business",
  • "shopify_location_id": "string",
  • "deleted": true,
  • "merchants": [
    ]
}