Get inventory data

get

https://www.locally.com/headless/api/1.0/conversion/store_data

Get information for one or many stores and their in-stock data for a given UPC (Universal Product Code).

Query Params

company_id

int32

required

The ID of the company.

dealers_company_id

int32

The ID of the company. Set to include authorized dealers.

only_store_id

int32

The ID of the store.

upc

string

The UPC code to retrieve stores and in-stock data for.

style

string

The ID of the style. Retrieves stores and in-stock data for related UPC codes. Use instead of UPC.

map_distance_unit

string

enum

required

The distance unit for the geographical region.

Allowed:

map_distance_diag

int32

required

The diagonal distance of the geographical region. Specify 1 if only_store_id is specified.

map_center_lat

string

Required if only_store_id is not specified. The latitude of the geographical region center.

map_center_lng

string

Required if only_store_id is not specified. The longitude of the geographical region center.

invalidate_cache

string

Results are cached by default for stateful (session) requests. Set to 'true' to invalidate the cache.

filters

string

Comma delimited list of statuses to filter by. Valid statuses are IN_STOCK, PTP_BOPIS, PTP_ROPIS, PTP_SDD and PTP_STS.

Headers

Locally-Api-Token

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

Loading…

Response

Click Try It! to start a request and see the response here!