Update location by adding new property
This endpoint does not override all the existing properties, rather it updates location by adding only those properties or by updating the existing location properties that are specified in the request body. Location is identified by the unique location number.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Path Parameters
location number
13
Body
Location details
Custom location attributes
{ "isReturns": true }
Unique number to identify the location
13
Name of the location
"CA"
true indicates location is active<br />false indicates location is inactive.
true
Location address details
Type of inventory location
"Warehouse"
Operating hours of the location
Operating hours of the location
coordinate details of the location in Geo Json format
JSON attributes on which locations are allowed to filter
{ "isCurbsidePickUp": false }
Response
This object contains location details
Location attribute object
{ "isReturns": true }
Unique location identifier
"622fae9a065d9e62a4029f79"
Unique number to identify the location
13
Location name
"CA"
true indicates location is active<br />false indicates location is inactive.
true
Location address details
Location type
"warehouse"
Date on which the location is created
Date on which the location is updated
Operating hours of the location
Operating hours of the location
coordinate details of the location in Geo Json format
JSON attributes on which locations are allowed to filter
{ "isCurbsidePickUp": false }
Was this page helpful?