> ## 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. # Update a product > Edits a product the acting seller owns. ## OpenAPI ````yaml /api-reference/seller.yaml patch /api/v3/seller/products/{id} openapi: 3.0.3 info: title: Seller API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: | Spree Seller API v3 - the marketplace seller panel, where a seller runs their own shop inside someone else's marketplace. This is a branch of its own, not a narrowing of the Admin API. Every endpoint is scoped server-side to the seller the request acts as, which is what makes cross-seller access impossible by construction rather than by rule. Sellers never call the Admin API. ## Authentication Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as `Authorization: Bearer `. The token carries a `seller_api` audience — a token minted for the storefront or the back office is not accepted here, and vice versa. There is deliberately **no secret API key** for this branch: a credential that could act as a seller without a seller signing in is exactly what the separate audience exists to prevent. ### Choosing a seller A user may run more than one seller. Login returns the list; send the chosen seller's ID in the `X-Spree-Seller-Id` header on every authenticated request. The store is derived from the seller — never sent — so no header can widen what a seller reaches. A request that names no seller the caller belongs to is rejected with `403`. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## 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: Seller sign-in, token refresh, logout, and invitation acceptance - name: Account description: The signed-in user, the sellers they may act for, and what they may do - name: Countries description: Country and state reference data for the panel's address forms - name: Delivery Methods description: >- The seller's own ways to ship, and the marketplace methods shared with them - name: Delivery Profiles description: >- The marketplace's delivery vocabulary — what kind of goods a product is, which decides how it ships - name: Delivery Zones description: >- The marketplace's destinations, for narrowing where a seller's own method ships - name: Onboarding description: >- The marketplace checklist a seller completes before admission, and what they submit against it - name: Policies description: The seller's own legal documents, as the marketplace asks them to publish - name: Product Types description: The types a seller may list a product against, and what each adds - name: Products description: The seller's own catalog - name: Profile description: >- The seller's own record — presentation, contact details, addresses, and tax registration - name: Stock Locations description: Where the seller keeps stock, and so where their returns are sent - name: Team description: Who runs this seller, and the invitations nobody has accepted yet - name: Files description: Uploading the files a profile, a submission or an import uses paths: /api/v3/seller/products/{id}: parameters: - name: id in: path description: Product ID required: true schema: type: string patch: tags: - Products summary: Update a product description: Edits a product the acting seller owns. parameters: - name: X-Spree-Seller-Id in: header required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductUpdateParams' required: true responses: '200': description: product updated content: application/json: example: id: prod_UkLWZg9DAJ name: Hand-thrown mug, large slug: product-2908212 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: true description: >- Vel minima recusandae iure deserunt non. Corrupti soluta pariatur recusandae saepe eveniet. Sequi deserunt fugiat architecto animi. Eum facilis veniam a consequatur minus. Dolor iure facilis repellendus tenetur. Nobis harum perferendis ab maiores labore eius eum quo. description_html: >- Vel minima recusandae iure deserunt non. Corrupti soluta pariatur recusandae saepe eveniet. Sequi deserunt fugiat architecto animi. Eum facilis veniam a consequatur minus. Dolor iure facilis repellendus tenetur. Nobis harum perferendis ab maiores labore eius eum quo. default_variant_id: variant_UkLWZg9DAJ buy_box_variant_id: variant_UkLWZg9DAJ thumbnail_url: null tags: [] price: id: price_UkLWZg9DAJ currency: USD amount: '19.99' compare_at_amount: null price_list_id: null original_price: null seller_id: sel_UkLWZg9DAJ status: active metadata: {} created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' product_type_id: null delivery_profile_id: fp_UkLWZg9DAJ schema: $ref: '#/components/schemas/Product' security: - bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Seller SDK source: |- import { createSellerClient } from '@spree/seller-sdk' const client = createSellerClient({ baseUrl: 'https://your-store.com', jwtToken: 'eyJhbGciOi...', sellerId: 'sel_UkLWZg9DAJ', }) const product = await client.products.update('prod_UkLWZg9DAJ', { name: 'Hand-thrown mug, large', }) components: schemas: ProductUpdateParams: type: object properties: name: type: string example: Hand-thrown mug description: type: string slug: type: string example: hand-thrown-mug meta_title: type: string meta_description: type: string meta_keywords: type: string metadata: type: object additionalProperties: true product_type_id: type: string description: >- The marketplace's product type this product is listed against, from the product types endpoint. Null detaches it. Saving with a type seeds its option types onto the product. nullable: true delivery_profile_id: type: string description: >- Which of the marketplace's delivery profiles the product ships under. A new product sent without one lands on the profile marked default. prices: type: array items: type: object properties: currency: allOf: - $ref: '#/components/schemas/CurrencyCode' description: >- Omit to price in the store's currency. A seller has no currency of their own. example: USD amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ description: >- A canonical decimal string (`"1234.56"`: period decimal, no grouping). The API does not parse localized input. example: '24.00' compare_at_amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '30.00' nullable: true required: - amount description: >- Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. media: type: array items: $ref: '#/components/schemas/SellerProductMediaParams' description: >- The gallery, as a whole: a file absent from the list is removed. `signed_id` attaches a fresh upload; `id` updates one already there. variants: type: array items: $ref: '#/components/schemas/ProductVariantParams' description: >- The variants, as a whole: one absent from the list is removed. Pass `id` to update an existing variant. 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: $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' 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 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 created_at: type: string updated_at: type: string product_type_id: type: string nullable: true delivery_profile_id: type: string nullable: true submission: allOf: - $ref: '#/components/schemas/ProductSubmission' nullable: true 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 - status - metadata - created_at - updated_at - product_type_id - delivery_profile_id x-typelizer: true CurrencyCode: 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 SellerProductMediaParams: type: object properties: id: type: string signed_id: type: string description: A `signed_id` from `POST /files`. alt: type: string example: Front view nullable: true position: type: integer example: 1 media_type: type: string enum: - image - video - external_video description: >- Defaults to `image`. `video` needs a `signed_id`; `external_video` needs an `external_video_url`. example: image external_video_url: type: string description: >- YouTube or Vimeo link. Required when `media_type` is `external_video`. nullable: true poster_signed_id: type: string description: A `signed_id` from `files.upload()` for a video's poster frame. focal_point_x: type: number description: Where the image is anchored when cropped, from 0 to 1. nullable: true focal_point_y: type: number description: Where the image is anchored when cropped, from 0 to 1. nullable: true variant_ids: type: array items: type: string description: >- Replaces the variants this media is linked to. An empty list clears them. ProductVariantParams: allOf: - $ref: '#/components/schemas/VariantParams' - type: object properties: id: type: string 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 required: - id - currency - amount - compare_at_amount - price_list_id 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 policies: type: array items: $ref: '#/components/schemas/Policy' required: - id - name - slug - about - about_html - logo_url - square_logo_url - cover_photo_url 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 created_at: type: string updated_at: type: string 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 - created_at - updated_at 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 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 created_at: type: string updated_at: type: string cost_price: type: string nullable: true preorderable: type: boolean available_stock: type: number nullable: true total_on_hand: type: number 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 - metadata - position - cost_currency - barcode - backorder_limit - hs_code - country_of_origin - customs_description - created_at - updated_at - cost_price - preorderable - available_stock - total_on_hand 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 required: - id - name - label - position - kind 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 required: - id - option_type_id - name - label - position - color_code - option_type_name - option_type_label - image_url 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' 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 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: {} required: - id - label - field_type - key - value 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 required: - id - currency - amount - recorded_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 required: - id - status - review_note - reviewed_at - created_at - product_id x-typelizer: true VariantParams: type: object properties: sku: type: string barcode: type: string cost_price: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ nullable: true cost_currency: $ref: '#/components/schemas/CurrencyCode' weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true depth: type: number nullable: true weight_unit: allOf: - $ref: '#/components/schemas/WeightUnit' description: Null falls back to the store's weight unit. nullable: true dimensions_unit: allOf: - $ref: '#/components/schemas/DimensionUnit' description: Null falls back to the store's unit system. nullable: true hs_code: type: string customs_description: type: string country_of_origin: $ref: '#/components/schemas/CountryCode' minimum_order_quantity: type: integer nullable: true order_multiple: type: integer nullable: true purchase_unit: type: string nullable: true enum: - unit - carton units_per_carton: type: integer description: How many units fill one carton. nullable: true carton_package_type_id: type: string description: >- The carton this variant is packed into: a package type of kind `carton`. Its dimensions are shared by every product packed the same way, so a corrected carton size fixes all of them at once. nullable: true carton_weight: type: number description: What one packed carton weighs, in the variant's weight unit. nullable: true cartons_per_pallet: type: integer description: How many cartons stack on one pallet. nullable: true track_inventory: type: boolean preorderable: type: boolean description: >- Sell this variant before it's in stock. Adds the pre-order label and ships-by promise; the cap comes from `backorder_limit`, an incoming stock count, or backorder. preorder_ships_at: type: string format: date-time description: >- The "ships by" date shown to customers while the variant is a pre-order. Once it passes, the variant is no longer a pre-order. Null clears it. nullable: true backorder_limit: type: integer description: >- Maximum units sellable beyond available stock, capping backorders and pre-orders. Null is unlimited. nullable: true position: type: integer options: type: array items: $ref: '#/components/schemas/VariantOptionParams' description: >- One pair per option type the variant takes part in (size, color). Option types and values are created when missing. prices: type: array items: type: object properties: currency: allOf: - $ref: '#/components/schemas/CurrencyCode' description: >- Omit to price in the store's currency. A seller has no currency of their own. example: USD amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ description: >- A canonical decimal string (`"1234.56"`: period decimal, no grouping). The API does not parse localized input. example: '24.00' compare_at_amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '30.00' nullable: true required: - amount description: Per-currency prices. Upserted by currency. stock_levels: type: array items: $ref: '#/components/schemas/StockLevelParams' description: >- Stock per location, at this seller's own locations only: a location belonging to anyone else is ignored. Policy: type: object properties: id: type: string name: type: string slug: type: string body: type: string nullable: true body_html: type: string nullable: true updated_at: type: string created_at: type: string required: - id - name - slug - body - body_html - updated_at - created_at 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 created_at: type: string updated_at: type: string allocated_count: type: number available_count: type: number stock_location: $ref: '#/components/schemas/StockLocation' required: - id - count_on_hand - backorderable - stock_location_id - variant_id - created_at - updated_at - allocated_count - available_count x-typelizer: true WeightUnit: type: string enum: - g - kg - lb - oz DimensionUnit: type: string enum: - mm - cm - in - ft CountryCode: 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 VariantOptionParams: type: object properties: name: type: string example: size value: type: string example: Small required: - name - value StockLevelParams: type: object properties: stock_location_id: type: string description: The location holding the stock (`sloc_...`). count_on_hand: type: integer description: >- Units physically at the location, not units available to sell: stock promised to placed orders counts until it ships. Sent as the count the shelf should end at; the API records the difference as an adjustment in the stock history. backorderable: type: boolean description: Whether this location sells the variant beyond what it holds. required: - stock_location_id - count_on_hand 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 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 kind: anyOf: - type: string enum: - warehouse - store - fulfillment_center - type: string description: The values listed are the built-in ones; extensions may add more. returns_enabled: type: boolean created_at: type: string updated_at: type: string required: - id - name - address1 - city - zipcode - country_code - country_name - state_code - state_text - pickup_ready_in_minutes - pickup_instructions - address2 - state_name - phone - company - active - default - kind - returns_enabled - created_at - updated_at x-typelizer: true securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for an authenticated seller session (`seller_api` audience) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.