Update details of a specific location

put

https://sandbox-api.unify-retail.com/v1/locations/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier of the location (location_id)

Body Params

location_id

string

length ≤ 20

name

string

length ≤ 100

address

object

zip_code

string

length ≤ 10

city

string

length ≤ 100

country_code

string

length ≤ 2

latitude

float

longitude

float

phone_number

string

length ≤ 16

mobile_number

string

length ≤ 16

string

length ≤ 100

closed

integer

enum

Whether the location is permanently closed. Setting it to 1 automatically forces ship_from_store, click_and_collect, click_and_go, unified_stock, available_in_store and e_reservation to 0, regardless of the values sent in this same request — a closed location no longer feeds the unified stock. This is one-way: setting it back to 0 does not restore any of those flags automatically.

Allowed:

store_locator

integer

enum

Allowed:

type

string

enum

Allowed:

google_business_id

string

length ≤ 50

Google Business ID for store locator integration

ship_from_store

integer

enum

Allowed:

click_and_collect

integer

enum

Allowed:

click_and_go

integer

enum

Allowed:

e_reservation

integer

enum

Allowed:

unified_stock

integer

enum

Allowed:

available_in_store

integer

enum

Allowed:

limit_schedule_sfs

integer

enum

Allowed:

limit_schedule_sfs_minutes

number

limit_process_order

number

opening_hours

object

website

string

length ≤ 255

website_store_app

string

length ≤ 255

units

array of strings

List of unit UUIDs (store prioritization groups) the location belongs to. Units are managed through the /v1/units endpoints. The list replaces the units currently linked to the location: omitting units (or sending an empty array) removes all existing links.

units

payment_methods_store_app

array of strings

StoreApp payment methods enabled for this location, in display order. Distinct from the POS payment_methods field.

payment_methods_store_app

Allowed:

company_id

string | null

The Company ID of the company to link to the location. It corresponds to the company registration number (e.g. SIREN in France). Send null to unlink the company.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad Request — Invalid parameters

401Unauthorized — Missing or invalid authentication

403Forbidden — Access denied to the resource

404Not Found — Resource doesn't exist

406Not Acceptable — The server cannot respond according to the Accept headers

422Unprocessable Entity — Validation failed

429Too Many Requests — Rate limit exceeded (tenant or API key). Headers are only returned when the API key limit is exceeded.

503Service Unavailable — Temporary backend issue