Edit Location

Use this API to edit a location using the store external ID.

Edits a location using the store external ID assigned to a location.

Only the fields that need to be updated are required to be in the body.

Path Params
string
required

storeExternalId of the Location. A unique id which you used during the creation of Pickup Location.

Body Params
string

Name of the pickup location

contact
object

Contact details of the pickup location

address
object

Address of the location

boolean

The pick up location can be marked as active or inactive using the true/false flag. Default is true (pickup location is enabled)

string
Defaults to USD

Currency code in ISO 4217 alphabetical format, e.g. USD. Defaults from Brand or Business if not provided.

string

Pickup instructions for the location

DSPs
array of objects

List of the providers that should be configured for the location

DSPs
dspAttributes
array

Dependant on provider attributes e.g., dspStoreId.

dspAttributes
string

When an order needs to be returned to a different location, enter the desired location's storeExternalId here.

additionalContacts
array of objects

To store additional contact details for a store

additionalContacts
tags
array of strings

Identifiers which can be used for finding and sorting relevant information.

tags
Responses

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