Organization API: Catalog & Services: Store
The 2 Organization API operations for store.
Part of Catalog & Services.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/store/products |
Published products in the key's sales channels, with count across every page |
| GET | /api/v1/orgs/{org_slug}/store/products/{id_or_handle} |
One published product by handle (or by id), priced like the list |
Published products in the key's sales channels, with count across every page
Section titled Published products in the key's sales channels, with count across every pageGET /api/v1/orgs/{org_slug}/store/products
Published products in the key's sales channels, with count across every page.
category_* includes the categories under it; collection_* follows a smart
collection's rules. Each variant is priced for the region and currency the
answer names. Send fields to get only the keys a page shows: the answer comes
back sooner when it leaves out variants, images and the other lists.
Parameters
Section titled Parameters| 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. |
fields |
query | string or null | no | Comma-separated top-level keys to answer, such as id,handle,title. id is always included. Relations you leave out are not loaded, so the answer comes back sooner. Without it the object is whole. A product's keys are id, handle, title, subtitle, description, thumbnail, product_type, vendor, is_giftcard, images, options, tags, collections, categories, seo, metadata, variants. A page that shows handles and metadata asks for handle,metadata; leaving out variants also skips pricing and stock. A key the product does not have answers 422 invalid_fields, with the keys allowed in allowed. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
One published product by handle (or by id), priced like the list
Section titled One published product by handle (or by id), priced like the listGET /api/v1/orgs/{org_slug}/store/products/{id_or_handle}
One published product by handle (or by id), priced like the list. Send
fields to get only the keys a page shows, as on the list.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
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 | |
fields |
query | string or null | no | Comma-separated top-level keys to answer, such as id,handle,title. id is always included. Relations you leave out are not loaded, so the answer comes back sooner. Without it the object is whole. A product's keys are id, handle, title, subtitle, description, thumbnail, product_type, vendor, is_giftcard, images, options, tags, collections, categories, seo, metadata, variants. A page that shows handles and metadata asks for handle,metadata; leaving out variants also skips pricing and stock. A key the product does not have answers 422 invalid_fields, with the keys allowed in allowed. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |