Spree Commerce · Example Payload
Spree Store Api Examples
Example requests and responses for the Spree Store API
E-CommerceHeadless CommerceProductsOrdersInventoryPaymentsPromotionsOpen SourceRuby on Rails
Spree Store Api Examples is an example object payload from Spree Commerce, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
titledescriptionschema_examplesresponse_examples
Example Payload
{
"title": "Spree Store API Examples",
"description": "Example requests and responses for the Spree Store API",
"schema_examples": {
"Cart": {
"id": "string",
"market_id": "string",
"number": "string",
"token": "string",
"email": "string",
"customer_note": "string",
"currency": "string",
"locale": "string",
"total_quantity": 0.0,
"item_total": "string",
"display_item_total": "string",
"adjustment_total": "string",
"display_adjustment_total": "string",
"discount_total": "string",
"display_discount_total": "string",
"tax_total": "string",
"display_tax_total": "string",
"included_tax_total": "string",
"display_included_tax_total": "string",
"additional_tax_total": "string",
"display_additional_tax_total": "string",
"total": "string",
"display_total": "string",
"gift_card_total": "string",
"display_gift_card_total": "string",
"amount_due": "string",
"display_amount_due": "string",
"delivery_total": "string",
"display_delivery_total": "string",
"warnings": [
{
"code": {},
"message": {},
"line_item_id": {},
"variant_id": {}
}
],
"store_credit_total": "string",
"display_store_credit_total": "string",
"covered_by_store_credit": true,
"current_step": "string",
"completed_steps": [
"string"
],
"requirements": [
{
"step": {},
"field": {},
"message": {}
}
],
"shipping_eq_billing_address": true,
"discounts": [
{
"id": {},
"promotion_id": {},
"name": {},
"description": {},
"code": {},
"amount": {},
"display_amount": {}
}
],
"items": [
{
"id": {},
"variant_id": {},
"quantity": {},
"currency": {},
"name": {},
"slug": {},
"options_text": {},
"price": {},
"display_price": {},
"total": {},
"display_total": {},
"adjustment_total": {},
"display_adjustment_total": {},
"additional_tax_total": {},
"display_additional_tax_total": {},
"included_tax_total": {},
"display_included_tax_total": {},
"discount_total": {},
"display_discount_total": {},
"pre_tax_amount": {},
"display_pre_tax_amount": {},
"discounted_amount": {},
"display_discounted_amount": {},
"display_compare_at_amount": {},
"compare_at_amount": {},
"thumbnail_url": {},
"option_values": {},
"digital_links": {}
}
],
"fulfillments": [
{
"id": {},
"number": {},
"tracking": {},
"tracking_url": {},
"cost": {},
"display_cost": {},
"total": {},
"display_total": {},
"discount_total": {},
"display_discount_total": {},
"additional_tax_total": {},
"display_additional_tax_total": {},
"included_tax_total": {},
"display_included_tax_total": {},
"tax_total": {},
"display_tax_total": {},
"status": {},
"fulfillment_type": {},
"fulfilled_at": {},
"items": {},
"delivery_method": {},
"stock_location": {},
"delivery_rates": {}
}
],
"payments": [
{
"id": {},
"payment_method_id": {},
"response_code": {},
"number": {},
"amount": {},
"display_amount": {},
"status": {},
"source_type": {},
"source_id": {},
"source": {},
"payment_method": {}
}
],
"billing_address": {},
"shipping_address": {},
"payment_methods": [
{
"id": {},
"name": {},
"description": {},
"type": {},
"session_required": {},
"source_required": {}
}
],
"gift_card": {},
"market": {}
},
"Product": {
"id": "string",
"name": "string",
"slug": "string",
"meta_title": "string",
"meta_description": "string",
"meta_keywords": "string",
"variant_count": 0.0,
"available_on": "string",
"purchasable": true,
"in_stock": true,
"backorderable": true,
"available": true,
"description": "string",
"description_html": "string",
"default_variant_id": "string",
"thumbnail_url": "string",
"tags": [
"string"
],
"price": {
"id": "string",
"amount": "string",
"amount_in_cents": 0.0,
"compare_at_amount": "string",
"compare_at_amount_in_cents": 0.0,
"currency": "string",
"display_amount": "string",
"display_compare_at_amount": "string",
"price_list_id": "string"
},
"original_price": {},
"primary_media": {
"id": "string",
"product_id": "string",
"variant_ids": [
{}
],
"position": 0.0,
"alt": "string",
"media_type": "string",
"focal_point_x": 0.0,
"focal_point_y": 0.0,
"external_video_url": "string",
"original_url": "string",
"mini_url": "string",
"small_url": "string",
"medium_url": "string",
"large_url": "string",
"xlarge_url": "string",
"og_image_url": "string"
},
"media": [
{
"id": {},
"product_id": {},
"variant_ids": {},
"position": {},
"alt": {},
"media_type": {},
"focal_point_x": {},
"focal_point_y": {},
"external_video_url": {},
"original_url": {},
"mini_url": {},
"small_url": {},
"medium_url": {},
"large_url": {},
"xlarge_url": {},
"og_image_url": {}
}
],
"variants": [
{
"id": {},
"product_id": {},
"sku": {},
"options_text": {},
"track_inventory": {},
"media_count": {},
"thumbnail_url": {},
"purchasable": {},
"in_stock": {},
"backorderable": {},
"weight": {},
"height": {},
"width": {},
"depth": {},
"price": {},
"original_price": {},
"primary_media": {},
"media": {},
"option_values": {},
"custom_fields": {},
"prior_price": {}
}
],
"default_variant": {
"id": "string",
"product_id": "string",
"sku": "string",
"options_text": "string",
"track_inventory": true,
"media_count": 0.0,
"thumbnail_url": "string",
"purchasable": true,
"in_stock": true,
"backorderable": true,
"weight": 0.0,
"height": 0.0,
"width": 0.0,
"depth": 0.0,
"price": {},
"original_price": {},
"primary_media": {},
"media": [
{}
],
"option_values": [
{}
],
"custom_fields": [
{}
],
"prior_price": {}
},
"option_types": [
{
"id": {},
"name": {},
"label": {},
"position": {},
"kind": {}
}
],
"categories": [
{
"id": {},
"name": {},
"permalink": {},
"position": {},
"depth": {},
"meta_title": {},
"meta_description": {},
"meta_keywords": {},
"children_count": {},
"parent_id": {},
"description": {},
"description_html": {},
"image_url": {},
"square_image_url": {},
"is_root": {},
"is_child": {},
"is_leaf": {},
"parent": {},
"children": {},
"ancestors": {},
"custom_fields": {}
}
],
"custom_fields": [
{
"id": {},
"label": {},
"type": {},
"field_type": {},
"key": {},
"value": {}
}
],
"prior_price": {}
},
"Order": {
"id": "string",
"market_id": "string",
"channel_id": "string",
"number": "string",
"email": "string",
"customer_note": "string",
"currency": "string",
"locale": "string",
"total_quantity": 0.0,
"item_total": "string",
"display_item_total": "string",
"adjustment_total": "string",
"display_adjustment_total": "string",
"discount_total": "string",
"display_discount_total": "string",
"tax_total": "string",
"display_tax_total": "string",
"included_tax_total": "string",
"display_included_tax_total": "string",
"additional_tax_total": "string",
"display_additional_tax_total": "string",
"total": "string",
"display_total": "string",
"gift_card_total": "string",
"display_gift_card_total": "string",
"amount_due": "string",
"display_amount_due": "string",
"delivery_total": "string",
"display_delivery_total": "string",
"fulfillment_status": "string",
"payment_status": "string",
"completed_at": "string",
"store_credit_total": "string",
"display_store_credit_total": "string",
"covered_by_store_credit": true,
"discounts": [
{
"id": {},
"promotion_id": {},
"name": {},
"description": {},
"code": {},
"amount": {},
"display_amount": {}
}
],
"items": [
{
"id": {},
"variant_id": {},
"quantity": {},
"currency": {},
"name": {},
"slug": {},
"options_text": {},
"price": {},
"display_price": {},
"total": {},
"display_total": {},
"adjustment_total": {},
"display_adjustment_total": {},
"additional_tax_total": {},
"display_additional_tax_total": {},
"included_tax_total": {},
"display_included_tax_total": {},
"discount_total": {},
"display_discount_total": {},
"pre_tax_amount": {},
"display_pre_tax_amount": {},
"discounted_amount": {},
"display_discounted_amount": {},
"display_compare_at_amount": {},
"compare_at_amount": {},
"thumbnail_url": {},
"option_values": {},
"digital_links": {}
}
],
"fulfillments": [
{
"id": {},
"number": {},
"tracking": {},
"tracking_url": {},
"cost": {},
"display_cost": {},
"total": {},
"display_total": {},
"discount_total": {},
"display_discount_total": {},
"additional_tax_total": {},
"display_additional_tax_total": {},
"included_tax_total": {},
"display_included_tax_total": {},
"tax_total": {},
"display_tax_total": {},
"status": {},
"fulfillment_type": {},
"fulfilled_at": {},
"items": {},
"delivery_method": {},
"stock_location": {},
"delivery_rates": {}
}
],
"payments": [
{
"id": {},
"payment_method_id": {},
"response_code": {},
"number": {},
"amount": {},
"display_amount": {},
"status": {},
"source_type": {},
"source_id": {},
"source": {},
"payment_method": {}
}
],
"billing_address": {},
"shipping_address": {},
"gift_card": {},
"market": {}
},
"Address": {
"id": "string",
"first_name": "string",
"last_name": "string",
"full_name": "string",
"address1": "string",
"address2": "string",
"postal_code": "string",
"city": "string",
"phone": "string",
"company": "string",
"country_name": "string",
"country_iso": "string",
"state_text": "string",
"state_abbr": "string",
"quick_checkout": true,
"is_default_billing": true,
"is_default_shipping": true,
"state_name": "string"
},
"CreditCard": {
"id": "string",
"brand": "string",
"last4": "string",
"month": 0.0,
"year": 0.0,
"name": "string",
"default": true,
"gateway_payment_profile_id": "string"
},
"Promotion": {
"id": "string",
"name": "string",
"description": "string",
"code": "string"
}
},
"response_examples": {
"post__api_v3_store_auth_login_200": {
"operationId": "post__api_v3_store_auth_login",
"method": "POST",
"path": "/api/v3/store/auth/login",
"status": "200",
"example": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjY0NjcwM2Q0LWY5ZjAtNDlmMi05ZmZkLTA3YTZhY2I5YWZkZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjE1fQ.jlz2KHxYkB1Dd9ucl26zy6E5M7dFB5q9g-Qw0YjsX50",
"refresh_token": "MQ9QZ1ToR8QocZoDd4ggC8yN",
"user": {
"id": "cus_UkLWZg9DAJ",
"email": "test@example.com",
"first_name": "Colette",
"last_name": "Hegmann",
"phone": null,
"accepts_email_marketing": false,
"full_name": "Colette Hegmann",
"available_store_credit_total": "0",
"display_available_store_credit_total": "$0.00",
"addresses": [],
"default_billing_address": null,
"default_shipping_address": null
}
}
},
"post__api_v3_store_auth_login_401": {
"operationId": "post__api_v3_store_auth_login",
"method": "POST",
"path": "/api/v3/store/auth/login",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"post__api_v3_store_auth_refresh_200": {
"operationId": "post__api_v3_store_auth_refresh",
"method": "POST",
"path": "/api/v3/store/auth/refresh",
"status": "200",
"example": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjNmZjU3NWU0LTVmNmItNDVjOC04MzIzLTIzMDMyMzVjZTkzMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjE2fQ.OuCk-UNe-asA8DvK2yKMkp94BQz9PN_Z7_SnReeIRYE",
"refresh_token": "qLuZDRo8LqywXFThqPM5V2Ug",
"user": {
"id": "cus_UkLWZg9DAJ",
"email": "test@example.com",
"first_name": "Debi",
"last_name": "Tillman",
"phone": null,
"accepts_email_marketing": false,
"full_name": "Debi Tillman",
"available_store_credit_total": "0",
"display_available_store_credit_total": "$0.00",
"addresses": [],
"default_billing_address": null,
"default_shipping_address": null
}
}
},
"post__api_v3_store_auth_refresh_401": {
"operationId": "post__api_v3_store_auth_refresh",
"method": "POST",
"path": "/api/v3/store/auth/refresh",
"status": "401",
"example": {
"error": {
"code": "invalid_refresh_token",
"message": "Invalid or expired refresh token"
}
}
},
"post__api_v3_store_password_resets_202": {
"operationId": "post__api_v3_store_password_resets",
"method": "POST",
"path": "/api/v3/store/password_resets",
"status": "202",
"example": {
"message": "If an account exists for that email, password reset instructions have been sent."
}
},
"post__api_v3_store_password_resets_401": {
"operationId": "post__api_v3_store_password_resets",
"method": "POST",
"path": "/api/v3/store/password_resets",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"patch__api_v3_store_password_resets_{token}_200": {
"operationId": "patch__api_v3_store_password_resets_{token}",
"method": "PATCH",
"path": "/api/v3/store/password_resets/{token}",
"status": "200",
"example": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjU1YjA5Yzc4LTUzMTYtNDRjYy05ZjJiLThmN2E2MzViMmRlNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjI4fQ.FX2Te4WfdAu3kN_fvvfHsH92_axvIZTI1d8Zmw8R1mE",
"refresh_token": "Be2HUCjiJVRjgidFuYU7GRRh",
"user": {
"id": "cus_UkLWZg9DAJ",
"email": "customer@example.com",
"first_name": "Randa",
"last_name": "O'Hara",
"phone": null,
"accepts_email_marketing": false,
"full_name": "Randa O'Hara",
"available_store_credit_total": "0",
"display_available_store_credit_total": "$0.00",
"addresses": [],
"default_billing_address": null,
"default_shipping_address": null
}
}
},
"patch__api_v3_store_password_resets_{token}_422": {
"operationId": "patch__api_v3_store_password_resets_{token}",
"method": "PATCH",
"path": "/api/v3/store/password_resets/{token}",
"status": "422",
"example": {
"error": {
"code": "validation_error",
"message": "Password confirmation doesn't match Password",
"details": {
"password_confirmation": [
"doesn't match Password"
]
}
}
}
},
"patch__api_v3_store_password_resets_{token}_401": {
"operationId": "patch__api_v3_store_password_resets_{token}",
"method": "PATCH",
"path": "/api/v3/store/password_resets/{token}",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"get__api_v3_store_categories_200": {
"operationId": "get__api_v3_store_categories",
"method": "GET",
"path": "/api/v3/store/categories",
"status": "200",
"example": {
"data": [
{
"id": "ctg_UkLWZg9DAJ",
"name": "taxonomy_3",
"permalink": "taxonomy-3",
"position": 0,
"depth": 0,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"children_count": 1,
"parent_id": null,
"description": "",
"description_html": "",
"image_url": null,
"square_image_url": null,
"is_root": true,
"is_child": false,
"is_leaf": false
},
{
"id": "ctg_gbHJdmfrXB",
"name": "taxon_3",
"permalink": "taxonomy-3/taxon-3",
"position": 0,
"depth": 1,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"children_count": 1,
"parent_id": "ctg_UkLWZg9DAJ",
"description": "",
"description_html": "",
"image_url": null,
"square_image_url": null,
"is_root": false,
"is_child": true,
"is_leaf": false
},
{
"id": "ctg_EfhxLZ9ck8",
"name": "taxon_4",
"permalink": "taxonomy-3/taxon-3/taxon-4",
"position": 0,
"depth": 2,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"children_count": 0,
"parent_id": "ctg_gbHJdmfrXB",
"description": "",
"description_html": "",
"image_url": null,
"square_image_url": null,
"is_root": false,
"is_child": true,
"is_leaf": true
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 3,
"pages": 1,
"from": 1,
"to": 3,
"in": 3,
"previous": null,
"next": null
}
}
},
"get__api_v3_store_categories_401": {
"operationId": "get__api_v3_store_categories",
"method": "GET",
"path": "/api/v3/store/categories",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"get__api_v3_store_categories_{id}_200": {
"operationId": "get__api_v3_store_categories_{id}",
"method": "GET",
"path": "/api/v3/store/categories/{id}",
"status": "200",
"example": {
"id": "ctg_gbHJdmfrXB",
"name": "taxon_12",
"permalink": "taxonomy-9/taxon-12",
"position": 0,
"depth": 1,
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"children_count": 1,
"parent_id": "ctg_UkLWZg9DAJ",
"description": "",
"description_html": "",
"image_url": null,
"square_image_url": null,
"is_root": false,
"is_child": true,
"is_leaf": false
}
},
"get__api_v3_store_categories_{id}_404": {
"operationId": "get__api_v3_store_categories_{id}",
"method": "GET",
"path": "/api/v3/store/categories/{id}",
"status": "404",
"example": {
"error": {
"code": "record_not_found",
"message": "Category not found"
}
}
},
"get__api_v3_store_categories_{id}_401": {
"operationId": "get__api_v3_store_categories_{id}",
"method": "GET",
"path": "/api/v3/store/categories/{id}",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"get__api_v3_store_products_200": {
"operationId": "get__api_v3_store_products",
"method": "GET",
"path": "/api/v3/store/products",
"status": "200",
"example": {
"data": [
{
"id": "prod_UkLWZg9DAJ",
"name": "Product 1421251",
"slug": "product-1421251",
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"variant_count": 1,
"available_on": "2025-05-26T16:14:22.402Z",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"description": "A comfortable cotton t-shirt.",
"description_html": "<p>A <strong>comfortable</strong> cotton t-shirt.</p>",
"default_variant_id": "variant_gbHJdmfrXB",
"thumbnail_url": null,
"tags": [],
"price": {
"id": "price_gbHJdmfrXB",
"amount": "19.99",
"amount_in_cents": 1999,
"compare_at_amount": null,
"compare_at_amount_in_cents": null,
"currency": "USD",
"display_amount": "$19.99",
"display_compare_at_amount": null,
"price_list_id": null
},
"original_price": null
},
{
"id": "prod_gbHJdmfrXB",
"name": "Product 1435220",
"slug": "product-1435220",
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"variant_count": 0,
"available_on": "2025-05-26T16:14:22.472Z",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"description": "Architecto dignissimos nemo inventore incidunt enim. Odit accusamus repellat error saepe culpa unde eius. Cupiditate officiis voluptatem autem perferendis qui vitae omnis sunt. Debitis dolor tempore ad impedit itaque reprehenderit delectus. Doloremque laudantium iure recusandae iusto debitis laborum consequuntur. Impedit eum optio commodi tempora cum quidem. Facere voluptatum nam possimus veritatis nostrum explicabo dolore ex. Adipisci iure unde nobis itaque amet nesciunt voluptatibus impedit. Numquam in accusantium magni itaque exercitationem. Quas vero maxime voluptatem rem impedit inventore. Esse perferendis asperiores ea expedita aut tenetur soluta. Enim accusantium dolor adipisci impedit. Error maxime neque accusamus facere provident eum. Cum officia velit asperiores quod cupiditate fugiat. Possimus tenetur aut consequuntur iusto cumque quas. Ab velit ullam qui pariatur veritatis omnis. Accusantium vero occaecati explicabo neque animi commodi. Necessitatibus perspiciatis iste culpa totam quibusdam voluptate distinctio. Quod aliquam ut et autem. Saepe ut asperiores et quisquam perspiciatis molestiae. Vel recusandae sunt nemo et accusamus veniam ducimus. Laborum modi quasi perferendis culpa laboriosam quaerat magnam. Facere at tempora iusto ex magni aliquam modi debitis.",
"description_html": "Architecto dignissimos nemo inventore incidunt enim. Odit accusamus repellat error saepe culpa unde eius. Cupiditate officiis voluptatem autem perferendis qui vitae omnis sunt. Debitis dolor tempore ad impedit itaque reprehenderit delectus. Doloremque laudantium iure recusandae iusto debitis laborum consequuntur.\nImpedit eum optio commodi tempora cum quidem. Facere voluptatum nam possimus veritatis nostrum explicabo dolore ex. Adipisci iure unde nobis itaque amet nesciunt voluptatibus impedit. Numquam in accusantium magni itaque exercitationem. Quas vero maxime voluptatem rem impedit inventore.\nEsse perferendis asperiores ea expedita aut tenetur soluta. Enim accusantium dolor adipisci impedit. Error maxime neque accusamus facere provident eum. Cum officia velit asperiores quod cupiditate fugiat. Possimus tenetur aut consequuntur iusto cumque quas.\nAb velit ullam qui pariatur veritatis omnis. Accusantium vero occaecati explicabo neque animi commodi. Necessitatibus perspiciatis iste culpa totam quibusdam voluptate distinctio. Quod aliquam ut et autem. Saepe ut asperiores et quisquam perspiciatis molestiae.\nVel recusandae sunt nemo et accusamus veniam ducimus. Laborum modi quasi perferendis culpa laboriosam quaerat magnam. Facere at tempora iusto ex magni aliquam modi debitis.",
"default_variant_id": "variant_EfhxLZ9ck8",
"thumbnail_url": null,
"tags": [],
"price": {
"id": "price_EfhxLZ9ck8",
"amount": "19.99",
"amount_in_cents": 1999,
"compare_at_amount": null,
"compare_at_amount_in_cents": null,
"currency": "USD",
"display_amount": "$19.99",
"display_compare_at_amount": null,
"price_list_id": null
},
"original_price": null
}
],
"meta": {
"page": 1,
"limit": 25,
"count": 2,
"pages": 1,
"from": 1,
"to": 2,
"in": 2,
"previous": null,
"next": null
}
}
},
"get__api_v3_store_products_401": {
"operationId": "get__api_v3_store_products",
"method": "GET",
"path": "/api/v3/store/products",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
},
"get__api_v3_store_products_{id}_200": {
"operationId": "get__api_v3_store_products_{id}",
"method": "GET",
"path": "/api/v3/store/products/{id}",
"status": "200",
"example": {
"id": "prod_UkLWZg9DAJ",
"name": "Product 1702106",
"slug": "product-1702106",
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"variant_count": 1,
"available_on": "2025-05-26T16:14:24.749Z",
"purchasable": true,
"in_stock": false,
"backorderable": true,
"available": true,
"description": "A comfortable cotton t-shirt.",
"description_html": "<p>A <strong>comfortable</strong> cotton t-shirt.</p>",
"default_variant_id": "variant_gbHJdmfrXB",
"thumbnail_url": null,
"tags": [],
"price": {
"id": "price_gbHJdmfrXB",
"amount": "19.99",
"amount_in_cents": 1999,
"compare_at_amount": null,
"compare_at_amount_in_cents": null,
"currency": "USD",
"display_amount": "$19.99",
"display_compare_at_amount": null,
"price_list_id": null
},
"original_price": null,
"prior_price": {
"id": "_AXs1igzRC6",
"amount": "9.99",
"amount_in_cents": 999,
"currency": "USD",
"display_amount": "$9.99",
"recorded_at": "2026-05-11T16:14:24Z"
}
}
},
"get__api_v3_store_products_{id}_404": {
"operationId": "get__api_v3_store_products_{id}",
"method": "GET",
"path": "/api/v3/store/products/{id}",
"status": "404",
"example": {
"error": {
"code": "record_not_found",
"message": "Product not found"
}
}
},
"get__api_v3_store_products_filters_200": {
"operationId": "get__api_v3_store_products_filters",
"method": "GET",
"path": "/api/v3/store/products/filters",
"status": "200",
"example": {
"filters": [
{
"id": "price",
"type": "price_range",
"min": 19.99,
"max": 19.99,
"currency": "USD"
},
{
"id": "availability",
"type": "availability",
"options": [
{
"id": "in_stock",
"count": 2
},
{
"id": "out_of_stock",
"count": 0
}
]
},
{
"id": "opt_UkLWZg9DAJ",
"type": "option",
"name": "size",
"label": "Size",
"kind": "dropdown",
"options": [
{
"id": "optval_UkLWZg9DAJ",
"name": "small",
"label": "S",
"position": 1,
"color_code": null,
"image_url": null,
"count": 1
}
]
},
{
"id": "categories",
"type": "category",
"options": [
{
"id": "ctg_EfhxLZ9ck8",
"name": "Shirts",
"permalink": "taxonomy-27/taxon-34/shirts",
"count": 2
}
]
}
],
"sort_options": [
{
"id": "manual"
},
{
"id": "best_selling"
},
{
"id": "price"
},
{
"id": "-price"
},
{
"id": "-available_on"
},
{
"id": "available_on"
},
{
"id": "name"
},
{
"id": "-name"
}
],
"default_sort": "manual",
"total_count": 2
}
},
"get__api_v3_store_products_filters_401": {
"operationId": "get__api_v3_store_products_filters",
"method": "GET",
"path": "/api/v3/store/products/filters",
"status": "401",
"example": {
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}
}
}
}