Update location by overriding existing details
This endpoint updates details of a location by overriding the existing values with the details that are specified in the request body, or creates a location if location does not exist. If an existing property is not mentioned in the request body, then the value for the existing property will be displayed as null or zero. Location is identified based on the 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.
Path Parameters
Unique number to identify the location
Body
Location details
Custom location attributes
Unique number to identify the location
Name of the location
true indicates location is active<br />false indicates location is inactive.
Location address details
Type of inventory location
Operating hours of the location
coordinate details of the location in Geo Json format
JSON attributes on which locations are allowed to filter
Response
This object contains location details
Location attribute object
Unique location identifier
Unique number to identify the location
Location name
true indicates location is active<br />false indicates location is inactive.
Location address details
Location type
Date on which the location is created
Date on which the location is updated
Operating hours of the location
coordinate details of the location in Geo Json format
JSON attributes on which locations are allowed to filter
Was this page helpful?