API Reference
HomeWebsite

Create a new location

post
https://sandbox-api.unify-retail.com/v1/locations
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 20
string
required
length ≤ 100
address
object
required
string
required
length ≤ 10
string
required
length ≤ 100
string
required
length ≤ 2
float
float
string
length ≤ 16
string
length ≤ 16
string
length ≤ 100
integer
enum
required

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:
integer
enum
Allowed:
string
enum
required
Allowed:
string
length ≤ 50

Google Business ID for store locator integration

integer
enum
Defaults to 0
Allowed:
integer
enum
Defaults to 0
Allowed:
integer
enum
Defaults to 0
Allowed:
integer
enum
Defaults to 0
Allowed:
integer
enum
Defaults to 0
Allowed:
integer
enum
Defaults to 0
Allowed:
integer
enum
Allowed:
number
number
opening_hours
object
string
length ≤ 255
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. Optional.

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:
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

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?