Organization API: Catalog & Services: Store

The 2 Organization API operations for store.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/store/products`	Published products in the key's sales channels
GET	`/api/v1/orgs/{org_slug}/store/products/{id_or_handle}`	One published product by handle (or by id), priced like the list

GET /api/v1/orgs/{org_slug}/store/products

Published products in the key's sales channels. category_* includes the categories under it; collection_* follows a smart collection's rules.

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`q`	query	string or null	no
`id`	query	array of integer or null	no	Only these product ids (at most 100)
`collection_id`	query	integer or null	no
`collection_handle`	query	string or null	no
`category_id`	query	integer or null	no
`category_handle`	query	string or null	no
`tag`	query	string or null	no
`sales_channel_id`	query	integer or null	no
`region_id`	query	integer or null	no
`country_code`	query	string or null	no
`currency_code`	query	string or null	no
`order`	query	string	no	Default: `-created_at`.
`limit`	query	integer	no	Default: `20`.
`offset`	query	integer	no	Default: `0`.

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

GET /api/v1/orgs/{org_slug}/store/products/{id_or_handle}

One published product by handle (or by id), priced like the list.

Name	In	Type	Required
`id_or_handle`	path	string	yes
`org_slug`	path	string	yes
`sales_channel_id`	query	integer or null	no
`region_id`	query	integer or null	no
`country_code`	query	string or null	no
`currency_code`	query	string or null	no

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.