Locations

Locations API for retailer store information across Narvar
Upsert Location
POST /locations

Authentication

Password

Request body

Object
location
Object
external_location_id
string required

Unique for retailer_moniker

Example:
2
enabled
boolean required
Example:
true
location_name
string
Example:
store 2
contact
Object
phone
string required
Example:
+14074372636
name
string
Example:
Store Front / Cash Wrap
address
Object required
street1
string
Example:
1 Blah Street
city
string
Example:
San Francisco
postal_code
string
Example:
94106
region_code
string
Example:
CA
country
string
Example:
US
street2
string
pickup_instructions
string
Example:
call the phone
location_group_id
string required
Example:
NYC
Get Location
GET /locations

Locations are returned already composite with their location group. So for instance if fulfillment hours are not specified on a location then they automatically come from the location group if present.

Request parameters

retailer_moniker
string optional
postal_code
string optional
country_code
string optional
radius
number optional

In miles from postal code specified.

limit
integer optional
Create Location Group
POST /groups

Authentication

Password

Request body

Object
location_group
Object
enabled
boolean required
Example:
true
location_group_name
string
Example:
store 2
retailer_moniker
string required
Example:
urbn
pickup_hours
Array
Object
day_of_week
string
Example:
Sunday
opening_hour
number
closing_hour
number
pickup_instructions
string
Example:
call the phone
fulfillment
Object
hours
Array
Object
day_of_week
string
opening_hour
number
closing_hour
number
lead_time
number

Time necessary to prepare a shipment

closures
Array
Object
date
string
Example:
2022-07-07T15:39:00.000Z
hours
Array
Object
day_of_week
string
opening_hour
number
closing_hour
number
Edit Location Group
PATCH /groups

Authentication

Password

Request body

Object
location_group
Object
enabled
boolean required
Example:
true
location_group_name
string
Example:
store 2
retailer_moniker
string
Example:
urbn
pickup_hours
Array
Object
day_of_week
string
Example:
Sunday
opening_hour
string
Example:
09:00
closing_hour
string
Example:
18:00
pickup_instructions
string
Example:
call the phone
fulfillment
Object
hours
Array
Object
day_of_week
string
opening_hour
string
closing_hour
string
lead_time
number

Time necessary to prepare a shipment

closures
Array
Object
date
string
Example:
2022-07-07T15:39:00.000Z
hours
Array
Object
day_of_week
string
opening_hour
string
closing_hour
string
id
string required

Location group ID (generated by locations service)

Get Location Groups
GET /groups

Locations are returned already composite with their location group. So for instance if fulfillment hours are not specified on a location then they automatically come from the location group if present.

Request parameters

retailer_moniker
string optional
limit
integer optional