RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

shop_location

A physical (or logical) shop location.

Inventory, pickup, and ship-from-store settings live here.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The shop_location object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

13 fields on shop_location. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Location id.

Type
id: string

name

string

Display name.

Type
name: string

code

string

Shop-scoped location code.

Type
code: string

fullAddress

string

Full address string.

Type
fullAddress: string

countryCode

string | null

ISO 3166-1 alpha-2 country code.

Type
countryCode: string | null

city

string | null

City.

Type
city: string | null

postalCode

string | null

Postal / ZIP code.

Type
postalCode: string | null

isActive

boolean

Whether the location is active.

Type
isActive: boolean

isDefault

boolean

Default location for the shop when true.

Type
isDefault: boolean

pickupEnabled

boolean

Customers can collect online orders here (when shop pickup is on).

Type
pickupEnabled: boolean

shipFromStoreEnabled

boolean

Online orders may ship from this location (All-in-One).

Type
shipFromStoreEnabled: boolean

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related