Locate products at stores by style or UPC

Given a style or a list of UPCs, locate stores that have the product in stock.

Query Params
int32
required

The ID of the company.

string
required

The latitude of the geographical region center.

string
required

The longitude of the geographical region center.

int32

The radius of the geographical region in miles.

int32

The radius of the geographical region in kilometers.

string

Limit results to a specific country code e.g. US, CA, etc.

int32

The number of stores to return. The default is 3.

string

The UPC code(s) of the item. For multiple UPCs, please specify be a comma-separated list. Use instead of style or color. Required if style and color are not provided.

string

The brand's style identifier as stored in Locally (typically the style_number from the brand's product feed). Retrieves stores and in-stock data for related UPC codes. Resolves within the company_id scope — for cross-brand lookups, the company_id must belong to the product owner. Use UPC if the owner is unknown. Use instead of UPC or color. Required if UPC and color are not provided.

string

The ID of the color. Retrieves stores and in-stock data for related UPC codes. Use instead of UPC or style. Required if UPC and style are not provided.

string

The name of the dealer category.

string

Comma delimited list of paths to purchase to filter by. Valid statuses are bopis, ropis, sdd and sts. If no paths to purchase supplied then all paths to purchase are returned.

Headers
string
required

Locally API token must be passed in the header to authenticate the API consumer

Responses
200

Successful

400

Bad Request

401

Unauthorized

402

Request Failed

403

Forbidden

404

Not Found

429

Too Many Requests

500

Server Error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!