> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Reject a submitted product > Turns down a product a seller submitted for review. The `reason` is sent back to the seller, who can fix the product and submit it again. **Required scope:** `write_products` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml patch /api/v3/admin/products/{id}/reject openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/products/{id}/reject: parameters: - name: id in: path required: true description: Product ID schema: type: string patch: tags: - Products summary: Reject a submitted product description: |- Turns down a product a seller submitted for review. The `reason` is sent back to the seller, who can fix the product and submit it again. **Required scope:** `write_products` (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductRejectParams' required: true responses: '200': description: product rejected content: application/json: example: id: prod_gbHJdmfrXB name: Product 1564387 slug: product-1564387 meta_title: null meta_description: null meta_keywords: null variant_count: 1 available_on: null preorder_ships_at: null purchasable: true preorder: false in_stock: false backorderable: true available: false description: >- Iste blanditiis quos vero ipsam reprehenderit quae. Culpa recusandae ut quisquam facilis enim dolorum eius. Sapiente explicabo animi necessitatibus perspiciatis doloribus aspernatur nobis. Labore similique ipsa debitis voluptate a. Nemo occaecati magnam quos voluptatibus amet. Facilis quis aperiam corporis corrupti enim. Voluptate dignissimos alias exercitationem repudiandae eligendi rerum hic. Facilis sed doloremque dicta porro saepe. Ipsam alias et ipsum voluptatum aperiam molestiae aliquam tempora. Quod ipsa quas eos hic corrupti dignissimos dolorum occaecati. Commodi quis animi at possimus laborum beatae. Aliquam vero suscipit reiciendis dolor placeat. Deleniti corporis tempora accusamus quae nesciunt animi. Numquam occaecati sapiente accusantium amet illum. Vero odio reprehenderit ipsa esse aliquid autem ad. description_html: >- Iste blanditiis quos vero ipsam reprehenderit quae. Culpa recusandae ut quisquam facilis enim dolorum eius. Sapiente explicabo animi necessitatibus perspiciatis doloribus aspernatur nobis. Labore similique ipsa debitis voluptate a. Nemo occaecati magnam quos voluptatibus amet. Facilis quis aperiam corporis corrupti enim. Voluptate dignissimos alias exercitationem repudiandae eligendi rerum hic. Facilis sed doloremque dicta porro saepe. Ipsam alias et ipsum voluptatum aperiam molestiae aliquam tempora. Quod ipsa quas eos hic corrupti dignissimos dolorum occaecati. Commodi quis animi at possimus laborum beatae. Aliquam vero suscipit reiciendis dolor placeat. Deleniti corporis tempora accusamus quae nesciunt animi. Numquam occaecati sapiente accusantium amet illum. Vero odio reprehenderit ipsa esse aliquid autem ad. default_variant_id: variant_gbHJdmfrXB buy_box_variant_id: variant_gbHJdmfrXB thumbnail_url: null tags: [] price: id: price_gbHJdmfrXB currency: USD amount: '19.99' compare_at_amount: null price_list_id: null min_quantity: 1 variant_id: variant_gbHJdmfrXB created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' original_price: null seller_id: null external_references: {} status: rejected metadata: {} deleted_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' delivery_profile_id: fp_UkLWZg9DAJ seller_name: null product_type_id: null tax_category_id: taxcat_UkLWZg9DAJ schema: $ref: '#/components/schemas/Product' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: >- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) // The seller sees the reason, fixes the product and submits it again. const product = await client.products.reject('prod_86Rf07xd4z', { reason: 'Photos are too dark', }) - lang: bash label: Spree CLI source: >- spree api patch /products/{id}/reject -d '{"reason":"Photos are too dark"}' components: schemas: ProductRejectParams: type: object properties: reason: type: string description: Why the submission was turned down. Sent back to the seller. Product: type: object properties: id: type: string name: type: string slug: type: string meta_title: type: string nullable: true meta_description: type: string nullable: true meta_keywords: type: string nullable: true variant_count: type: number available_on: type: string nullable: true preorder_ships_at: type: string nullable: true purchasable: type: boolean preorder: type: boolean in_stock: type: boolean backorderable: type: boolean available: type: boolean description: type: string nullable: true description_html: type: string nullable: true default_variant_id: type: string buy_box_variant_id: type: string nullable: true thumbnail_url: type: string nullable: true tags: type: array items: type: string price: allOf: - $ref: '#/components/schemas/Price' nullable: true original_price: allOf: - $ref: '#/components/schemas/Price' nullable: true seller_id: type: string nullable: true seller: $ref: '#/components/schemas/Seller' primary_media: $ref: '#/components/schemas/Media' media: type: array items: $ref: '#/components/schemas/Media' variants: type: array items: $ref: '#/components/schemas/Variant' default_variant: $ref: '#/components/schemas/Variant' option_types: type: array items: $ref: '#/components/schemas/OptionType' option_values: type: array items: $ref: '#/components/schemas/OptionValue' categories: type: array items: $ref: '#/components/schemas/Category' custom_fields: type: array items: $ref: '#/components/schemas/CustomField' prior_price: allOf: - $ref: '#/components/schemas/PriceHistory' nullable: true external_references: type: object translations: type: object status: anyOf: - type: string enum: - draft - active - archived - proposed - rejected - type: string description: The values listed are the built-in ones; extensions may add more. metadata: type: object deleted_at: type: string nullable: true created_at: type: string updated_at: type: string delivery_profile_id: type: string nullable: true submission: allOf: - $ref: '#/components/schemas/ProductSubmission' nullable: true seller_name: type: string nullable: true product_type_id: type: string nullable: true tax_category_id: type: string nullable: true digital_assets: type: array items: $ref: '#/components/schemas/DigitalAsset' collections: type: array items: $ref: '#/components/schemas/Collection' product_publications: type: array items: $ref: '#/components/schemas/ProductPublication' channels: type: array items: $ref: '#/components/schemas/Channel' product_type: $ref: '#/components/schemas/ProductType' required: - id - name - slug - meta_title - meta_description - meta_keywords - variant_count - available_on - preorder_ships_at - purchasable - preorder - in_stock - backorderable - available - description - description_html - default_variant_id - buy_box_variant_id - thumbnail_url - tags - price - original_price - seller_id - external_references - status - metadata - deleted_at - created_at - updated_at - delivery_profile_id - seller_name - product_type_id - tax_category_id x-typelizer: true Price: type: object properties: id: type: string currency: type: string nullable: true enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR amount: type: string nullable: true compare_at_amount: type: string nullable: true price_list_id: type: string nullable: true min_quantity: type: number variant_id: type: string nullable: true created_at: type: string updated_at: type: string variant: $ref: '#/components/schemas/Variant' required: - id - currency - amount - compare_at_amount - price_list_id - min_quantity - variant_id - created_at - updated_at x-typelizer: true Seller: type: object properties: id: type: string name: type: string slug: type: string about: type: string about_html: type: string logo_url: type: string nullable: true square_logo_url: type: string nullable: true cover_photo_url: type: string nullable: true status: anyOf: - type: string enum: - pending - invited - canceled - onboarding - ready_for_review - approved - rejected - suspended - type: string description: The values listed are the built-in ones; extensions may add more. contact_email: type: string nullable: true billing_email: type: string nullable: true tax_remittance: type: string enum: - seller - platform payouts_schedule_interval: type: string nullable: true enum: - daily - weekly - biweekly - monthly - manual metadata: type: object nullable: true holiday_mode_until: type: string nullable: true terms_accepted_at: type: string nullable: true created_at: type: string updated_at: type: string deleted_at: type: string nullable: true minimum_payout_amount: type: string nullable: true on_holiday: type: boolean sellable: type: boolean products_count: type: number users_count: type: number onboarding_progress: type: object onboarding_complete: type: boolean legal_name: type: string nullable: true registration_number: type: string nullable: true billing_address: $ref: '#/components/schemas/Address' returns_address: $ref: '#/components/schemas/Address' required: - id - name - slug - about - about_html - logo_url - square_logo_url - cover_photo_url - status - contact_email - billing_email - tax_remittance - payouts_schedule_interval - metadata - holiday_mode_until - terms_accepted_at - created_at - updated_at - deleted_at - minimum_payout_amount - on_holiday - sellable - products_count - users_count - onboarding_progress - onboarding_complete - legal_name - registration_number x-typelizer: true Media: type: object properties: id: type: string product_id: type: string nullable: true variant_ids: type: array items: type: string position: type: number alt: type: string nullable: true media_type: type: string enum: - image - video - external_video external_video_url: type: string nullable: true focal_point_x: type: number nullable: true focal_point_y: type: number nullable: true video_provider: type: string nullable: true video_embed_url: type: string nullable: true video_url: type: string nullable: true poster_url: type: string nullable: true original_url: type: string nullable: true mini_url: type: string nullable: true small_url: type: string nullable: true medium_url: type: string nullable: true large_url: type: string nullable: true xlarge_url: type: string nullable: true og_image_url: type: string nullable: true external_references: type: object created_at: type: string updated_at: type: string attached: type: boolean filename: type: string nullable: true content_type: type: string nullable: true byte_size: type: number nullable: true embed_url: type: string nullable: true signed_id: type: string nullable: true viewable_id: type: string nullable: true download_url: type: string nullable: true metadata: type: object viewable_type: type: string nullable: true required: - id - product_id - variant_ids - position - alt - media_type - external_video_url - focal_point_x - focal_point_y - video_provider - video_embed_url - video_url - poster_url - original_url - mini_url - small_url - medium_url - large_url - xlarge_url - og_image_url - external_references - created_at - updated_at - attached - filename - content_type - byte_size - embed_url - signed_id - viewable_id - download_url - metadata - viewable_type x-typelizer: true Variant: type: object properties: id: type: string product_id: type: string sku: type: string nullable: true options_text: type: string track_inventory: type: boolean media_count: type: number preorder_ships_at: type: string nullable: true thumbnail_url: type: string nullable: true purchasable: type: boolean in_stock: type: boolean backorderable: type: boolean preorder: type: boolean weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true depth: type: number nullable: true weight_unit: type: string enum: - g - kg - lb - oz dimensions_unit: type: string enum: - mm - cm - in - ft minimum_order_quantity: type: number nullable: true order_multiple: type: number nullable: true purchase_unit: type: string nullable: true enum: - unit - carton units_per_carton: type: number nullable: true price: $ref: '#/components/schemas/Price' original_price: allOf: - $ref: '#/components/schemas/Price' nullable: true seller_id: type: string nullable: true seller: $ref: '#/components/schemas/Seller' primary_media: $ref: '#/components/schemas/Media' media: type: array items: $ref: '#/components/schemas/Media' option_values: type: array items: $ref: '#/components/schemas/OptionValue' custom_fields: type: array items: $ref: '#/components/schemas/CustomField' prior_price: allOf: - $ref: '#/components/schemas/PriceHistory' nullable: true external_references: type: object metadata: type: object position: type: number cost_currency: type: string nullable: true enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR barcode: type: string nullable: true backorder_limit: type: number nullable: true hs_code: type: string nullable: true country_of_origin: type: string nullable: true enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW customs_description: type: string nullable: true carton_weight: type: string nullable: true cartons_per_pallet: type: number nullable: true deleted_at: type: string nullable: true created_at: type: string updated_at: type: string cost_price: type: string nullable: true preorderable: type: boolean tax_category_id: type: string nullable: true carton_package_type_id: type: string nullable: true units_per_pallet: type: number nullable: true available_stock: type: number nullable: true reserved_quantity: type: number total_on_hand: type: number nullable: true product_name: type: string delivery_profile_id: type: string nullable: true prices: type: array items: $ref: '#/components/schemas/Price' stock_levels: type: array items: $ref: '#/components/schemas/StockLevel' required: - id - product_id - sku - options_text - track_inventory - media_count - preorder_ships_at - thumbnail_url - purchasable - in_stock - backorderable - preorder - weight - height - width - depth - weight_unit - dimensions_unit - minimum_order_quantity - order_multiple - purchase_unit - units_per_carton - price - original_price - seller_id - option_values - external_references - metadata - position - cost_currency - barcode - backorder_limit - hs_code - country_of_origin - customs_description - carton_weight - cartons_per_pallet - deleted_at - created_at - updated_at - cost_price - preorderable - tax_category_id - carton_package_type_id - units_per_pallet - available_stock - reserved_quantity - total_on_hand - product_name - delivery_profile_id x-typelizer: true OptionType: type: object properties: id: type: string name: type: string label: type: string position: type: number kind: type: string enum: - dropdown - color_swatch - buttons translations: type: object metadata: type: object filterable: type: boolean created_at: type: string updated_at: type: string option_values: type: array items: $ref: '#/components/schemas/OptionValue' required: - id - name - label - position - kind - metadata - filterable - created_at - updated_at x-typelizer: true OptionValue: type: object properties: id: type: string option_type_id: type: string name: type: string label: type: string position: type: number color_code: type: string nullable: true option_type_name: type: string option_type_label: type: string image_url: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string option_type: $ref: '#/components/schemas/OptionType' required: - id - option_type_id - name - label - position - color_code - option_type_name - option_type_label - image_url - metadata - created_at - updated_at x-typelizer: true Category: type: object properties: id: type: string name: type: string permalink: type: string position: type: number depth: type: number meta_title: type: string nullable: true meta_description: type: string nullable: true meta_keywords: type: string nullable: true children_count: type: number parent_id: type: string nullable: true description: type: string description_html: type: string image_url: type: string nullable: true square_image_url: type: string nullable: true is_root: type: boolean is_child: type: boolean is_leaf: type: boolean parent: $ref: '#/components/schemas/Category' children: type: array items: $ref: '#/components/schemas/Category' ancestors: type: array items: $ref: '#/components/schemas/Category' custom_fields: type: array items: $ref: '#/components/schemas/CustomField' external_references: type: object translations: type: object metadata: type: object pretty_name: type: string lft: type: number rgt: type: number products_count: type: number created_at: type: string updated_at: type: string required: - 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 - external_references - metadata - pretty_name - lft - rgt - products_count - created_at - updated_at x-typelizer: true CustomField: type: object properties: id: type: string label: type: string field_type: type: string enum: - short_text - long_text - rich_text - number - boolean - json key: type: string value: {} created_at: type: string updated_at: type: string storefront_visible: type: boolean custom_field_definition_id: type: string required: - id - label - field_type - key - value - created_at - updated_at - storefront_visible - custom_field_definition_id x-typelizer: true PriceHistory: type: object properties: id: type: string currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SKK - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMM - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYI - UYU - UYW - UZS - VED - VEF - VES - VND - VUV - WST - XAF - XCD - XCG - XOF - XPF - YER - ZAR - ZMK - ZMW - ZWD - ZWG - ZWL - ZWN - ZWR amount: type: string nullable: true recorded_at: type: string variant_id: type: string price_id: type: string compare_at_amount: type: string nullable: true created_at: type: string required: - id - currency - amount - recorded_at - variant_id - price_id - compare_at_amount - created_at x-typelizer: true ProductSubmission: type: object properties: id: type: string status: anyOf: - type: string enum: - pending - approved - rejected - withdrawn - type: string description: The values listed are the built-in ones; extensions may add more. review_note: type: string nullable: true reviewed_at: type: string nullable: true created_at: type: string product_id: type: string metadata: type: object nullable: true updated_at: type: string submitted_by_id: type: string nullable: true reviewed_by_id: type: string nullable: true reviewed_by_name: type: string nullable: true auto_approved: type: boolean required: - id - status - review_note - reviewed_at - created_at - product_id - metadata - updated_at - submitted_by_id - reviewed_by_id - reviewed_by_name - auto_approved x-typelizer: true DigitalAsset: type: object properties: id: type: string variant_id: type: string nullable: true filename: type: string nullable: true content_type: type: string nullable: true authorized_clicks: type: number nullable: true authorized_days: type: number nullable: true byte_size: type: number nullable: true created_at: type: string updated_at: type: string provider_type: type: string nullable: true description: >- Digital asset provider; null is an uploaded file. Built-in: file. Extensions may register more. provider_name: type: string description: >- Digital asset provider name. Built-in: File. Extensions may register more. download_url: type: string nullable: true effective_authorized_clicks: type: number effective_authorized_days: type: number provider_settings: type: object required: - id - variant_id - filename - content_type - authorized_clicks - authorized_days - byte_size - created_at - updated_at - provider_type - provider_name - download_url - effective_authorized_clicks - effective_authorized_days - provider_settings x-typelizer: true Collection: type: object properties: id: type: string name: type: string permalink: type: string position: type: number sort_order: type: string enum: - manual - best_selling - price asc - price desc - available_on desc - available_on asc - name asc - name desc meta_title: type: string nullable: true meta_description: type: string nullable: true meta_keywords: type: string nullable: true products_count: type: number description: type: string description_html: type: string image_url: type: string nullable: true square_image_url: type: string nullable: true custom_fields: type: array items: $ref: '#/components/schemas/CustomField' translations: type: object automatic: type: boolean rules_match_policy: type: string enum: - all - any metadata: type: object created_at: type: string updated_at: type: string rules: type: array items: $ref: '#/components/schemas/CollectionRule' required: - id - name - permalink - position - sort_order - meta_title - meta_description - meta_keywords - products_count - description - description_html - image_url - square_image_url - automatic - rules_match_policy - metadata - created_at - updated_at x-typelizer: true ProductPublication: type: object properties: id: type: string published_at: type: string nullable: true unpublished_at: type: string nullable: true product_id: type: string channel_id: type: string created_at: type: string updated_at: type: string required: - id - published_at - unpublished_at - product_id - channel_id - created_at - updated_at x-typelizer: true Channel: type: object properties: id: type: string name: type: string code: type: string active: type: boolean default: type: boolean storefront_access: type: string nullable: true enum: - public - prices_hidden - login_required guest_checkout: type: boolean nullable: true created_at: type: string updated_at: type: string order_routing_strategy: type: string nullable: true description: >- Order routing strategy; null inherits the store setting. Built-in: rules. Extensions may register more. stock_location_ids: type: array items: type: string default_catalog_id: type: string nullable: true required: - id - name - code - active - default - storefront_access - guest_checkout - created_at - updated_at - order_routing_strategy - stock_location_ids - default_catalog_id x-typelizer: true ProductType: type: object properties: id: type: string name: type: string translations: type: object products_count: type: number created_at: type: string updated_at: type: string delivery_profile_id: type: string nullable: true option_type_ids: type: array items: type: string category_ids: type: array items: type: string custom_field_definitions: type: array items: $ref: '#/components/schemas/ProductTypeCustomFieldDefinition' required: - id - name - products_count - created_at - updated_at - delivery_profile_id - option_type_ids - category_ids - custom_field_definitions x-typelizer: true Address: type: object properties: id: type: string label: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string address1: type: string nullable: true address2: type: string nullable: true postal_code: type: string nullable: true city: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true country_name: type: string country_code: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW state_text: type: string nullable: true state_code: type: string nullable: true quick_checkout: type: boolean is_default_billing: type: boolean is_default_shipping: type: boolean state_name: type: string nullable: true owner: allOf: - $ref: '#/components/schemas/AddressOwner' nullable: true metadata: type: object created_at: type: string updated_at: type: string latitude: type: number nullable: true longitude: type: number nullable: true customer_id: type: string nullable: true required: - id - label - first_name - last_name - full_name - address1 - address2 - postal_code - city - phone - company - country_name - country_code - state_text - state_code - quick_checkout - is_default_billing - is_default_shipping - state_name - owner - metadata - created_at - updated_at - latitude - longitude - customer_id x-typelizer: true StockLevel: type: object properties: id: type: string count_on_hand: type: number backorderable: type: boolean stock_location_id: type: string nullable: true variant_id: type: string nullable: true external_references: type: object metadata: type: object reserved_count: type: number incoming_count: type: number purchasable_count: type: number variant_name: type: string nullable: true variant_sku: type: string nullable: true created_at: type: string updated_at: type: string stock_location_name: type: string nullable: true product_id: type: string nullable: true options_text: type: string nullable: true thumbnail_url: type: string nullable: true allocated_count: type: number available_count: type: number stock_location: $ref: '#/components/schemas/StockLocation' variant: $ref: '#/components/schemas/Variant' required: - id - count_on_hand - backorderable - stock_location_id - variant_id - external_references - metadata - reserved_count - incoming_count - purchasable_count - variant_name - variant_sku - created_at - updated_at - stock_location_name - product_id - options_text - thumbnail_url - allocated_count - available_count x-typelizer: true CollectionRule: type: object properties: id: type: string value: type: string nullable: true match_policy: type: string enum: - is_equal_to - is_not_equal_to - contains - does_not_contain type: type: string description: >- Rule type. Built-in: tag, available_on, sale. Extensions may register more. required: - id - value - match_policy - type x-typelizer: true ProductTypeCustomFieldDefinition: type: object properties: id: type: string key: type: string namespace: type: string label: type: string field_type: type: string enum: - short_text - long_text - rich_text - number - boolean - json required: type: boolean sort_order: type: number required: - id - key - namespace - label - field_type - required - sort_order x-typelizer: true AddressOwner: type: object properties: id: type: string type: anyOf: - type: string enum: - customer - company - seller - type: string description: The values listed are the built-in ones; extensions may add more. name: type: string nullable: true required: - id - type - name x-typelizer: true StockLocation: type: object properties: id: type: string name: type: string address1: type: string nullable: true city: type: string nullable: true zipcode: type: string nullable: true country_code: type: string nullable: true enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW country_name: type: string nullable: true state_code: type: string nullable: true state_text: type: string nullable: true pickup_ready_in_minutes: type: number nullable: true pickup_instructions: type: string nullable: true external_references: type: object admin_name: type: string nullable: true address2: type: string nullable: true state_name: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true active: type: boolean default: type: boolean backorderable_default: type: boolean propagate_all_variants: type: boolean kind: anyOf: - type: string enum: - warehouse - store - fulfillment_center - type: string description: The values listed are the built-in ones; extensions may add more. pickup_enabled: type: boolean pickup_stock_policy: type: string enum: - local - any returns_enabled: type: boolean created_at: type: string updated_at: type: string seller_id: type: string nullable: true seller_name: type: string nullable: true seller: $ref: '#/components/schemas/Seller' required: - id - name - address1 - city - zipcode - country_code - country_name - state_code - state_text - pickup_ready_in_minutes - pickup_instructions - external_references - admin_name - address2 - state_name - phone - company - active - default - backorderable_default - propagate_all_variants - kind - pickup_enabled - pickup_stock_policy - returns_enabled - created_at - updated_at - seller_id - seller_name x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.