Sites, shops, and locations

Load the current brand/site, find a fulfillment location, and select the shop and room used by later shopping calls. Store selection can return a new API key.

Access labels such as Origin + Brand key + Customer are defined in Headers and access. Each endpoint ends in a Try it console; set the host and keys once in its Settings tab or on the overview.

Get listed hub by brand

Method	URL path	Required access
GET	/api/v1/listed/hubs	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
query.listedHubId	number	optional	—
query.show_on_nearest	boolean	optional	—
query.limit	number	optional	—
query.offset	number	optional	—
query.search	string	optional	Whitespace trimmed
query.lat	number	optional	—
query.lng	number	optional	—
query.city	string	optional	No controller schema
query.country	string	optional	No controller schema
query.state	string	optional	No controller schema

city, state, and country become the internal groupQuery filter. Send them as query fields, not as a nested groupQuery object.

Example:

curl -X GET "$BASE_URL/api/v1/listed/hubs?limit=10&offset=0" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/listedHub_controller.js:10 → getListedHubByBrand; routes: routes/v1/listedHub_route.js:32; service: _getListedHubByBrand (app/v1/service/listedHub_service.ts:35).

Get listed hub markers by brand

Method	URL path	Required access
GET	/api/v1/listed/hubs/markers	Origin + Brand key

Request fields: no body, query, or path fields are read by this controller. Context comes from the headers/middleware above.

Example:

curl -X GET "$BASE_URL/api/v1/listed/hubs/markers" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/listedHub_controller.js:82 → getListedHubMarkersByBrand; routes: routes/v1/listedHub_route.js:45; service: _getListedHubMarkersByBrand (app/v1/service/listedHub_service.ts:208).

Get all brands and hub by marketplace

Method	URL path	Required access
GET	/api/v1/marketplace/brands-hubs	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
query.name	string	optional	Whitespace trimmed

Example:

curl -X GET "$BASE_URL/api/v1/marketplace/brands-hubs" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/marketplace_controller.js:201 → getAllBrandsAndHubByMarketplace; routes: routes/v1/marketplace_route.js:19; service: _getAllBrandsAndHubByMarketplace (app/v1/service/marketplace_service.js:177).

Get tenant details

Method	URL path	Required access
POST	/api/v1/tenant	Origin

No brand key on this route

/api/v1/tenant is listed although its route does not check api-key: the storefront at start-up, to get the brand key calls it. Sending the key anyway is harmless.

Request fields:

Field	Type	Required	Rules / meaning
body.payload	object	yes	—
body.payload.country	string	optional	Whitespace trimmed; Country code from country_iso_codes, for example US or CA
body.payload.latitude	number	optional	—
body.payload.longitude	number	optional	—
body.payload.callnearest	boolean	optional	—

The response sets an apiKey cookie and returns result.apiKey. Explicitly send the api-key header for subsequent website calls.

Example:

curl -X POST "$BASE_URL/api/v1/tenant" \
  -H "Origin: $ORIGIN" \
  -H 'Content-Type: application/json' \
  --data-raw '{"payload":{}}'

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: Site/tenant configuration including apiKey.

Source: app/v1/controller/site_controller.js:63 → getTenantDetails; routes: routes/v1/site_route.ts:35; service: _getSiteDetails (app/v1/service/site_service.js:38).

Select hub for tenant

Method	URL path	Required access
PUT	/api/v1/set-hub	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
body.payload	object	yes	—
body.payload.hubId	number	yes	—
body.payload.roomId	number	yes	—
body.payload.type	string	yes	Whitespace trimmed; Allowed values ("DELIVERY", "POS", "RAPID", "PICKUP", "SHIPMENT")

Example:

curl -X PUT "$BASE_URL/api/v1/set-hub" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{"payload":{"hubId":1,"roomId":1,"type":"DELIVERY"}}'

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: apiKey.

Source: app/v1/controller/site_controller.js:264 → selectHubForTenant; routes: routes/v1/site_route.ts:44; service: _selectHubForTenant (app/v1/service/site_service.js:777).

Get nearest

Method	URL path	Required access
POST	/api/v1/nearest	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
body.payload	object	yes	—
body.payload.address	string	yes	Whitespace trimmed
body.payload.productIds	array of number	optional	—

Example:

curl -X POST "$BASE_URL/api/v1/nearest" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{"payload":{"address":"123 Example Street, New York, NY"}}'

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: pickup, rapid, delivery.

Source: app/v1/controller/site_controller.js:142 → getNearest; routes: routes/v1/site_route.ts:54; service: _fetchNearest (app/v1/service/site_service.js:419).

Select hub for multi type

Method	URL path	Required access
PUT	/api/v1/set-hub/multiple	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
body.payload	object	yes	—
body.payload.hubId	number	yes	—
body.payload.roomId	number	yes	—
body.payload.type	array of string	yes	—

Example:

curl -X PUT "$BASE_URL/api/v1/set-hub/multiple" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{"payload":{"hubId":1,"roomId":1,"type":["DELIVERY"]}}'

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/site_controller.js:102 → selectHubForMultiType; routes: routes/v1/site_route.ts:64; service: _selectHubForMultiType (app/v1/service/site_service.js:377).

Nearest hub by zip code

Method	URL path	Required access
POST	/api/v1/nearest/zipcode	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
body.payload	object	yes	—
body.payload.zipcode	string	yes	Whitespace trimmed

Example:

curl -X POST "$BASE_URL/api/v1/nearest/zipcode" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{"payload":{"zipcode":"10001"}}'

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/site_controller.js:299 → nearestHubByZipCode; routes: routes/v1/site_route.ts:74; service: _nearestHubByZipCode (app/v1/service/site_service.js:1007).

Related pages

• Shop-to-order flow (web)
• Batch Commerce API overview
• Finding a store
• Implementation notes