Skip to main content
POST
/
commerce
/
inventory
/
v1
/
location
Error
A valid request URL is required to generate request examples
[
  {
    "locationID": 123,
    "tenantID": 123,
    "locationCode": "<string>",
    "express": true,
    "includeInLocationExport": true,
    "includeInAggregate": true,
    "active": true,
    "directShip": true,
    "pickup": true,
    "transferEnabled": true,
    "postalCode": "<string>",
    "countryCode": "<string>",
    "latitude": 123,
    "longitude": 123,
    "locationName": "<string>",
    "wmsEnabled": true,
    "success": true,
    "messages": [
      "<string>"
    ],
    "numResults": 123
  }
]

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

Location Request Object

Location Request Object

tenantID
integer
required

Tenant ID

locationCode
string
required

Location Code

active
boolean
required

Flag for whether the location is active

directShip
boolean
required

Flag for whether the location allows Direct Ship (STH) orders

pickup
boolean
required

Flag for whether the location allows Pickup (BOPIS) orders

locationName
string
required

Location Name

express
boolean

Flag for whether the location is express enabled or not

includeInLocationExport
boolean

Flag for whether the location is to be included in location exports

includeInAggregate
boolean

Flag for whether the location is to be included in aggregate exports

transferEnabled
boolean

Flag for whether the location allows Transfer orders

postalCode
string

Postal Code

countryCode
string

Country Code

latitude
number

Latitude

longitude
number

Longitude

wmsEnabled
boolean

Flag for whether the location is WMS Enabled

Response

Success

locationID
integer

Internal Location ID

tenantID
integer

Tenant ID

locationCode
string

Location Code

express
boolean

Flag for whether the location is express enabled or not

includeInLocationExport
boolean

Flag for whether the location is to be included in location exports

includeInAggregate
boolean

Flag for whether the location is to be included in aggregate exports

active
boolean

Flag for whether the location is active

directShip
boolean

Flag for whether the location allows Direct Ship (STH) orders

pickup
boolean

Flag for whether the location allows Pickup (BOPIS) orders

transferEnabled
boolean

Flag for whether the location allows Transfer orders

postalCode
string

Postal Code

countryCode
string

Country Code

latitude
number

Latitude

longitude
number

Longitude

locationName
string

Location Name

wmsEnabled
boolean

Flag for whether the location is WMS Enabled

success
boolean

Flag for success

messages
string[]

List of messages

numResults
integer

Number of results