> ## 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. # Get a price list > **Required scope:** `read_products` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/price_lists/{id} 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: 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 or cancellation 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/price_lists/{id}: parameters: - name: id in: path required: true schema: type: string get: tags: - Pricing summary: Get a price list description: '**Required scope:** `read_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 - name: expand in: query required: false schema: type: string responses: '200': description: price list found content: application/json: example: id: pl_UkLWZg9DAJ name: Wholesale description: null status: draft position: 1 match_policy: all adjust_compare_at: false starts_at: null ends_at: null deleted_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' price_adjustment_percentage: null automatic_pricing: false currently_active: false products_count: 0 prices_count: 0 price_adjustment_tiers: [] schema: $ref: '#/components/schemas/PriceList' '404': description: price list not found content: application/json: example: error: code: record_not_found message: Price list not found schema: $ref: '#/components/schemas/ErrorResponse' 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', }) const priceList = await client.priceLists.get('pl_xxx') - lang: bash label: Spree CLI source: spree api get /price_lists/{id} components: schemas: PriceList: type: object properties: id: type: string name: type: string description: type: string nullable: true status: anyOf: - type: string enum: - draft - active - inactive - scheduled - type: string description: The values listed are the built-in ones; extensions may add more. position: type: number match_policy: type: string enum: - all - any adjust_compare_at: type: boolean starts_at: type: string nullable: true ends_at: type: string nullable: true deleted_at: type: string nullable: true created_at: type: string updated_at: type: string price_adjustment_percentage: type: string nullable: true automatic_pricing: type: boolean currently_active: type: boolean products_count: type: number prices_count: type: number price_adjustment_tiers: type: array items: $ref: '#/components/schemas/PriceAdjustmentTier' price_rules: type: array items: $ref: '#/components/schemas/PriceRule' required: - id - name - description - status - position - match_policy - adjust_compare_at - starts_at - ends_at - deleted_at - created_at - updated_at - price_adjustment_percentage - automatic_pricing - currently_active - products_count - prices_count - price_adjustment_tiers x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid PriceAdjustmentTier: type: object properties: id: type: string min_quantity: type: number percentage: type: string required: - id - min_quantity - percentage x-typelizer: true PriceRule: type: object properties: id: type: string created_at: type: string updated_at: type: string type: type: string description: >- Rule type. Built-in: channel_rule, customer_group_rule, market_rule, user_rule, volume_rule, zone_rule. Extensions may register more. price_list_id: type: string preferences: type: object preference_schema: type: array items: $ref: '#/components/schemas/PreferenceField' markets: type: array items: $ref: '#/components/schemas/Market' customer_groups: type: array items: $ref: '#/components/schemas/CustomerGroup' channels: type: array items: $ref: '#/components/schemas/Channel' customers: type: array items: $ref: '#/components/schemas/Customer' required: - id - created_at - updated_at - type - price_list_id - preferences - preference_schema x-typelizer: true PreferenceField: type: object description: >- A single configurable preference on a payment method, promotion rule/action, or calculator. The frontend uses `type` + `default` to render a sensible input. properties: key: type: string example: amount_min type: type: string example: decimal description: >- string | text | password | integer | decimal | boolean | array | hash default: description: Default value (any JSON type), null when there is no default nullable: true required: - key - type Market: type: object properties: id: type: string name: type: string currency: type: string default_locale: type: string tax_inclusive: type: boolean default: type: boolean country_codes: type: array items: type: string country_isos: type: array items: type: string supported_locales: type: array items: type: string countries: type: array items: $ref: '#/components/schemas/Country' created_at: type: string updated_at: type: string tax_provider: type: string nullable: true description: >- Tax provider; null uses the store default. Built-in: internal. Provider gems register more. required: - id - name - currency - default_locale - tax_inclusive - default - country_codes - country_isos - supported_locales - created_at - updated_at - tax_provider x-typelizer: true CustomerGroup: type: object properties: id: type: string name: type: string description: type: string nullable: true customers_count: type: number created_at: type: string updated_at: type: string customers: type: array items: $ref: '#/components/schemas/Customer' required: - id - name - description - customers_count - 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 guest_checkout: type: boolean preferred_storefront_access: type: string nullable: true preferred_guest_checkout: type: boolean nullable: true created_at: type: string updated_at: type: string preferred_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 - preferred_storefront_access - preferred_guest_checkout - created_at - updated_at - preferred_order_routing_strategy - stock_location_ids - default_catalog_id x-typelizer: true Customer: type: object properties: id: type: string email: type: string first_name: type: string nullable: true last_name: type: string nullable: true phone: type: string nullable: true accepts_email_marketing: type: boolean email_marketing_consent_updated_at: type: string nullable: true full_name: type: string available_store_credit_total: type: string display_available_store_credit_total: type: string addresses: type: array items: $ref: '#/components/schemas/Address' default_billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true default_shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true newsletter_subscriber: allOf: - $ref: '#/components/schemas/NewsletterSubscriber' nullable: true customer_groups: type: array items: $ref: '#/components/schemas/CustomerGroup' failed_attempts: type: number metadata: type: object email_marketing_consent_source: type: string nullable: true created_at: type: string updated_at: type: string anonymized_at: type: string nullable: true anonymized: type: boolean tags: type: array items: type: string internal_note: type: string nullable: true internal_note_html: type: string nullable: true default_billing_address_id: type: string nullable: true default_shipping_address_id: type: string nullable: true orders_count: type: number total_spent: type: string display_total_spent: type: string last_order_completed_at: type: string nullable: true orders: type: array items: $ref: '#/components/schemas/Order' store_credits: type: array items: $ref: '#/components/schemas/StoreCredit' customer_group_ids: type: array items: type: string companies: type: array items: $ref: '#/components/schemas/Company' required: - id - email - first_name - last_name - phone - accepts_email_marketing - email_marketing_consent_updated_at - full_name - available_store_credit_total - display_available_store_credit_total - failed_attempts - metadata - email_marketing_consent_source - created_at - updated_at - anonymized_at - anonymized - tags - internal_note - internal_note_html - default_billing_address_id - default_shipping_address_id - orders_count - total_spent - display_total_spent - last_order_completed_at - customer_group_ids x-typelizer: true Country: type: object properties: iso: type: string iso3: type: string name: type: string states_required: type: boolean zipcode_required: type: boolean states: type: array items: $ref: '#/components/schemas/State' market: allOf: - $ref: '#/components/schemas/Market' nullable: true required: - iso - iso3 - name - states_required - zipcode_required 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 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_abbr: type: string nullable: true country_iso: type: string state_name: type: string 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 owner_id: type: string nullable: true owner_type: 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_abbr - country_iso - state_name - metadata - created_at - updated_at - latitude - longitude - customer_id - owner_id - owner_type x-typelizer: true NewsletterSubscriber: type: object properties: id: type: string email: type: string created_at: type: string updated_at: type: string verified: type: boolean verified_at: type: string nullable: true customer_id: type: string nullable: true required: - id - email - created_at - updated_at - verified - verified_at - customer_id x-typelizer: true Order: type: object properties: id: type: string market_id: type: string nullable: true withdrawal_period_ends_at: type: string nullable: true within_withdrawal_period: type: boolean cart_id: type: string nullable: true channel_id: type: string nullable: true company_id: type: string nullable: true company_name: type: string nullable: true po_document_filename: type: string nullable: true po_document_byte_size: type: number nullable: true number: type: string email: type: string customer_note: type: string nullable: true po_number: type: string nullable: true currency: type: string locale: type: string nullable: true total_quantity: type: number coupon_code: type: string nullable: true fulfillment_status: type: string nullable: true enum: - backorder - canceled - partial - unfulfilled - fulfilled - delivered - pending - ready - shipped payment_status: type: string nullable: true enum: - none - authorized - partially_paid - paid - partially_refunded - refunded - overcharged - voided completed_at: type: string nullable: true item_total: type: string display_item_total: type: string adjustment_total: type: string display_adjustment_total: type: string discount_total: type: string display_discount_total: type: string tax_total: type: string display_tax_total: type: string included_tax_total: type: string display_included_tax_total: type: string additional_tax_total: type: string display_additional_tax_total: type: string total: type: string display_total: type: string gift_card_total: type: string display_gift_card_total: type: string amount_due: type: string display_amount_due: type: string delivery_total: type: string display_delivery_total: type: string fee_total: type: string display_fee_total: type: string store_credit_total: type: string display_store_credit_total: type: string covered_by_store_credit: type: boolean items: type: array items: $ref: '#/components/schemas/LineItem' fulfillments: type: array items: $ref: '#/components/schemas/Fulfillment' payments: type: array items: $ref: '#/components/schemas/Payment' billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true gift_card: allOf: - $ref: '#/components/schemas/GiftCard' nullable: true market: allOf: - $ref: '#/components/schemas/Market' nullable: true external_references: type: object status: type: string enum: - draft - placed - canceled last_ip_address: type: string nullable: true considered_risky: type: boolean confirmation_delivered: type: boolean store_owner_notification_delivered: type: boolean payment_total: type: string display_payment_total: type: string metadata: type: object cancel_note: type: string nullable: true commission_amount_total: type: string display_commission_amount_total: type: string commission_tax_total: type: string display_commission_tax_total: type: string commission_total: type: string display_commission_total: type: string canceled_at: type: string nullable: true approved_at: type: string nullable: true created_at: type: string updated_at: type: string preferred_stock_location_id: type: string nullable: true po_document_url: type: string nullable: true seller_id: type: string nullable: true seller: $ref: '#/components/schemas/Seller' order_group_id: type: string nullable: true tags: type: array items: type: string internal_note: type: string nullable: true internal_note_html: type: string nullable: true approver_id: type: string nullable: true approver_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. approver: $ref: '#/components/schemas/Actor' canceler_id: type: string nullable: true canceler_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. canceler: $ref: '#/components/schemas/Actor' created_by_id: type: string nullable: true created_by_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. created_by: $ref: '#/components/schemas/Actor' cancel_reason_id: type: string nullable: true cancel_reason_name: type: string nullable: true customer_id: type: string nullable: true applied_promotions: type: array items: $ref: '#/components/schemas/AppliedPromotion' payment_splits: type: array items: $ref: '#/components/schemas/PaymentSplit' cart: $ref: '#/components/schemas/Cart' channel: $ref: '#/components/schemas/Channel' preferred_stock_location: $ref: '#/components/schemas/StockLocation' payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethod' customer: $ref: '#/components/schemas/Customer' cancel_reason: $ref: '#/components/schemas/OrderCancellationReason' returns: type: array items: $ref: '#/components/schemas/Return' exchanges: type: array items: $ref: '#/components/schemas/Exchange' claims: type: array items: $ref: '#/components/schemas/Claim' freight_summary: allOf: - $ref: '#/components/schemas/FreightSummary' nullable: true required: - id - market_id - withdrawal_period_ends_at - within_withdrawal_period - cart_id - channel_id - company_id - company_name - po_document_filename - po_document_byte_size - number - email - customer_note - po_number - currency - locale - total_quantity - coupon_code - fulfillment_status - payment_status - completed_at - item_total - display_item_total - adjustment_total - display_adjustment_total - discount_total - display_discount_total - tax_total - display_tax_total - included_tax_total - display_included_tax_total - additional_tax_total - display_additional_tax_total - total - display_total - gift_card_total - display_gift_card_total - amount_due - display_amount_due - delivery_total - display_delivery_total - fee_total - display_fee_total - store_credit_total - display_store_credit_total - covered_by_store_credit - gift_card - market - external_references - status - last_ip_address - considered_risky - confirmation_delivered - store_owner_notification_delivered - payment_total - display_payment_total - metadata - cancel_note - commission_amount_total - display_commission_amount_total - commission_tax_total - display_commission_tax_total - commission_total - display_commission_total - canceled_at - approved_at - created_at - updated_at - preferred_stock_location_id - po_document_url - seller_id - order_group_id - tags - internal_note - internal_note_html - approver_id - approver_type - canceler_id - canceler_type - created_by_id - created_by_type - cancel_reason_id - cancel_reason_name - customer_id - freight_summary x-typelizer: true StoreCredit: type: object properties: id: type: string amount: type: string amount_used: type: string amount_remaining: type: string display_amount: type: string display_amount_used: type: string display_amount_remaining: type: string currency: type: string memo: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string amount_authorized: type: string outstanding: type: boolean display_amount_authorized: type: string customer_id: type: string nullable: true created_by_id: type: string nullable: true originator_type: type: string nullable: true originator_id: type: string nullable: true customer: $ref: '#/components/schemas/Customer' created_by: $ref: '#/components/schemas/AdminUser' required: - id - amount - amount_used - amount_remaining - display_amount - display_amount_used - display_amount_remaining - currency - memo - metadata - created_at - updated_at - amount_authorized - outstanding - display_amount_authorized - customer_id - created_by_id - originator_type - originator_id x-typelizer: true Company: type: object properties: id: type: string name: type: string kind: type: string enum: - company - division po_number_required: type: boolean parent_id: type: string nullable: true ancestors: type: object external_references: type: object metadata: type: object nullable: true created_at: type: string updated_at: type: string children_count: type: number members_count: type: number children: type: array items: $ref: '#/components/schemas/Company' addresses: type: array items: $ref: '#/components/schemas/Address' memberships: type: array items: $ref: '#/components/schemas/CompanyMembership' required: - id - name - kind - po_number_required - parent_id - ancestors - external_references - metadata - created_at - updated_at - children_count - members_count x-typelizer: true State: type: object properties: abbr: type: string name: type: string required: - abbr - name x-typelizer: true LineItem: type: object properties: id: type: string variant_id: type: string seller_id: type: string nullable: true preorder: type: boolean preorder_ships_at: type: string nullable: true quantity: type: number currency: type: string name: type: string slug: type: string options_text: type: string price: type: string display_price: type: string total: type: string display_total: type: string adjustment_total: type: string display_adjustment_total: type: string additional_tax_total: type: string display_additional_tax_total: type: string included_tax_total: type: string display_included_tax_total: type: string discount_total: type: string display_discount_total: type: string pre_tax_amount: type: string display_pre_tax_amount: type: string discounted_amount: type: string display_discounted_amount: type: string display_compare_at_amount: type: string nullable: true compare_at_amount: type: string nullable: true thumbnail_url: type: string nullable: true seller: $ref: '#/components/schemas/Seller' option_values: type: array items: $ref: '#/components/schemas/OptionValue' digital_links: type: array items: $ref: '#/components/schemas/DigitalLink' tax_lines: type: array items: $ref: '#/components/schemas/TaxLine' metadata: type: object price_source: type: string nullable: true created_at: type: string updated_at: type: string catalog_price: type: string nullable: true price_list_id: type: string nullable: true price_list_name: type: string nullable: true catalog_id: type: string nullable: true catalog_name: type: string nullable: true cost_price: type: string nullable: true tax_category_id: type: string nullable: true variant: $ref: '#/components/schemas/Variant' tax_category: $ref: '#/components/schemas/TaxCategory' required: - id - variant_id - seller_id - preorder - preorder_ships_at - 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 - metadata - price_source - created_at - updated_at - catalog_price - price_list_id - price_list_name - catalog_id - catalog_name - cost_price - tax_category_id x-typelizer: true Fulfillment: type: object properties: id: type: string number: type: string tracking: type: string nullable: true tracking_url: type: string nullable: true pickup_point_data: type: object nullable: true selected_delivery_rate_id: type: string nullable: true unpriced: type: boolean cost: type: string display_cost: type: string total: type: string display_total: type: string discount_total: type: string display_discount_total: type: string additional_tax_total: type: string display_additional_tax_total: type: string included_tax_total: type: string display_included_tax_total: type: string tax_total: type: string display_tax_total: type: string status: anyOf: - type: string enum: - unfulfilled - fulfilled - delivered - canceled - type: string description: The values listed are the built-in ones; extensions may add more. fulfillment_type: type: string enum: - shipping - digital - pickup - pickup_point fulfilled_at: type: string nullable: true delivered_at: type: string nullable: true items: type: array items: $ref: '#/components/schemas/FulfillmentManifestItem' deliveries: type: array items: $ref: '#/components/schemas/Delivery' delivery_method: $ref: '#/components/schemas/DeliveryMethod' stock_location: $ref: '#/components/schemas/StockLocation' delivery_rates: type: array items: $ref: '#/components/schemas/DeliveryRate' tax_lines: type: array items: $ref: '#/components/schemas/TaxLine' metadata: type: object adjustment_total: type: string pre_tax_amount: type: string created_at: type: string updated_at: type: string order_id: type: string nullable: true stock_location_id: type: string nullable: true documents: type: object labels: type: array items: $ref: '#/components/schemas/ShippingLabel' provider_generates_labels: type: boolean fulfillment_items: type: array items: $ref: '#/components/schemas/FulfillmentItem' order: $ref: '#/components/schemas/Order' required: - id - number - tracking - tracking_url - pickup_point_data - selected_delivery_rate_id - unpriced - 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 - delivered_at - items - deliveries - metadata - adjustment_total - pre_tax_amount - created_at - updated_at - order_id - stock_location_id - documents - labels - provider_generates_labels x-typelizer: true Payment: type: object properties: id: type: string payment_method_id: type: string response_code: type: string nullable: true number: type: string status: anyOf: - type: string enum: - checkout - processing - pending - completed - failed - void - invalid - type: string description: The values listed are the built-in ones; extensions may add more. amount: type: string display_amount: type: string source_type: type: string nullable: true enum: - credit_card - store_credit - payment_source source_id: type: string nullable: true source: anyOf: - $ref: '#/components/schemas/CreditCard' - $ref: '#/components/schemas/StoreCredit' - $ref: '#/components/schemas/PaymentSource' nullable: true payment_method: $ref: '#/components/schemas/PaymentMethod' metadata: type: object avs_response: type: string nullable: true cvv_response_code: type: string nullable: true cvv_response_message: type: string nullable: true created_at: type: string updated_at: type: string captured_amount: type: string order_id: type: string nullable: true order: $ref: '#/components/schemas/Order' refunds: type: array items: $ref: '#/components/schemas/Refund' payment_splits: type: array items: $ref: '#/components/schemas/PaymentSplit' required: - id - payment_method_id - response_code - number - status - amount - display_amount - source_type - source_id - source - metadata - avs_response - cvv_response_code - cvv_response_message - created_at - updated_at - captured_amount - order_id x-typelizer: true GiftCard: type: object properties: id: type: string code: type: string status: anyOf: - type: string enum: - active - partially_redeemed - redeemed - canceled - expired - type: string description: The values listed are the built-in ones; extensions may add more. currency: type: string amount: type: string amount_used: type: string amount_authorized: type: string amount_remaining: type: string display_amount: type: string display_amount_used: type: string display_amount_remaining: type: string expires_at: type: string nullable: true redeemed_at: type: string nullable: true expired: type: boolean active: type: boolean created_at: type: string updated_at: type: string customer_id: type: string nullable: true created_by_id: type: string nullable: true customer: $ref: '#/components/schemas/Customer' created_by: $ref: '#/components/schemas/AdminUser' gift_card_batch: $ref: '#/components/schemas/GiftCardBatch' orders: type: array items: $ref: '#/components/schemas/Order' required: - id - code - status - currency - amount - amount_used - amount_authorized - amount_remaining - display_amount - display_amount_used - display_amount_remaining - expires_at - redeemed_at - expired - active - created_at - updated_at - customer_id - created_by_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 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 payouts_schedule_interval: type: string nullable: true 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 Actor: type: object properties: id: type: string type: anyOf: - type: string enum: - admin_user - api_key - type: string description: The values listed are the built-in ones; extensions may add more. label: type: string nullable: true required: - id - type - label x-typelizer: true AppliedPromotion: type: object properties: id: type: string promotion_id: type: string name: type: string description: type: string nullable: true code: type: string nullable: true amount: type: string display_amount: type: string created_at: type: string updated_at: type: string required: - id - promotion_id - name - description - code - amount - display_amount - created_at - updated_at x-typelizer: true PaymentSplit: type: object properties: id: type: string currency: type: string created_at: type: string updated_at: type: string authorized_amount: type: string display_authorized_amount: type: string captured_amount: type: string display_captured_amount: type: string refunded_amount: type: string display_refunded_amount: type: string claimed_amount: type: string display_claimed_amount: type: string net_captured_amount: type: string display_net_captured_amount: type: string refundable_amount: type: string display_refundable_amount: type: string payment_id: type: string payment_number: type: string nullable: true order_id: type: string order_number: type: string nullable: true required: - id - currency - created_at - updated_at - authorized_amount - display_authorized_amount - captured_amount - display_captured_amount - refunded_amount - display_refunded_amount - claimed_amount - display_claimed_amount - net_captured_amount - display_net_captured_amount - refundable_amount - display_refundable_amount - payment_id - payment_number - order_id - order_number x-typelizer: true Cart: type: object properties: id: type: string market_id: type: string nullable: true channel_id: type: string nullable: true preferred_stock_location_id: type: string nullable: true company_id: type: string nullable: true company_name: type: string nullable: true po_number_required: type: boolean po_document_filename: type: string nullable: true po_document_byte_size: type: number nullable: true number: type: string token: type: string email: type: string nullable: true customer_note: type: string nullable: true po_number: type: string nullable: true currency: type: string locale: type: string nullable: true total_quantity: type: number warnings: type: array items: $ref: '#/components/schemas/CartWarning' coupon_code: type: string nullable: true item_total: type: string nullable: true display_item_total: type: string nullable: true adjustment_total: type: string nullable: true display_adjustment_total: type: string nullable: true discount_total: type: string nullable: true display_discount_total: type: string nullable: true tax_total: type: string nullable: true display_tax_total: type: string nullable: true included_tax_total: type: string nullable: true display_included_tax_total: type: string nullable: true additional_tax_total: type: string nullable: true display_additional_tax_total: type: string nullable: true total: type: string nullable: true display_total: type: string nullable: true gift_card_total: type: string nullable: true display_gift_card_total: type: string nullable: true amount_due: type: string nullable: true display_amount_due: type: string nullable: true delivery_total: type: string nullable: true display_delivery_total: type: string nullable: true fee_total: type: string nullable: true display_fee_total: type: string nullable: true store_credit_total: type: string nullable: true display_store_credit_total: type: string nullable: true covered_by_store_credit: type: boolean current_step: type: string completed_steps: type: array items: type: string requirements: type: array items: $ref: '#/components/schemas/CheckoutRequirement' order_minimum: type: number nullable: true order_minimum_shortfall: type: number nullable: true below_order_minimum: type: boolean nullable: true freight_summary: allOf: - $ref: '#/components/schemas/FreightSummary' nullable: true shipping_eq_billing_address: type: boolean items: type: array items: $ref: '#/components/schemas/LineItem' billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true market: allOf: - $ref: '#/components/schemas/Market' nullable: true completed_at: type: string nullable: true created_at: type: string updated_at: type: string applied_promotions: type: array items: $ref: '#/components/schemas/AppliedPromotion' required: - id - market_id - channel_id - preferred_stock_location_id - company_id - company_name - po_number_required - po_document_filename - po_document_byte_size - number - token - email - customer_note - po_number - currency - locale - total_quantity - warnings - coupon_code - item_total - display_item_total - adjustment_total - display_adjustment_total - discount_total - display_discount_total - tax_total - display_tax_total - included_tax_total - display_included_tax_total - additional_tax_total - display_additional_tax_total - total - display_total - gift_card_total - display_gift_card_total - amount_due - display_amount_due - delivery_total - display_delivery_total - fee_total - display_fee_total - store_credit_total - display_store_credit_total - covered_by_store_credit - current_step - completed_steps - requirements - order_minimum - order_minimum_shortfall - below_order_minimum - freight_summary - shipping_eq_billing_address - items - billing_address - shipping_address - market - completed_at - created_at - updated_at - applied_promotions 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 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 PaymentMethod: type: object properties: id: type: string name: type: string description: type: string nullable: true type: type: string description: >- Payment method type. Built-in: check, store_credit, custom_payment_source_method, bogus (test only); payment provider gems register their own, for example stripe. session_required: type: boolean source_required: type: boolean metadata: type: object active: type: boolean auto_capture: type: boolean nullable: true capture_method: type: string enum: - checkout - on_dispatch - manual nullable: true resolved_capture_method: type: string enum: - checkout - on_dispatch - manual storefront_visible: type: boolean position: type: number created_at: type: string updated_at: type: string preferences: type: object preference_schema: type: object required: - id - name - description - type - session_required - source_required - metadata - active - auto_capture - capture_method - resolved_capture_method - storefront_visible - position - created_at - updated_at - preferences - preference_schema x-typelizer: true OrderCancellationReason: type: object properties: id: type: string name: type: string active: type: boolean created_at: type: string updated_at: type: string can_be_deleted: type: boolean required: - id - name - active - created_at - updated_at - can_be_deleted x-typelizer: true Return: type: object properties: id: type: string number: type: string status: anyOf: - type: string enum: - requested - approved - received - refunded - canceled - type: string description: The values listed are the built-in ones; extensions may add more. order_id: type: string nullable: true reason_id: type: string nullable: true refund_total: type: string display_refund_total: type: string refund_tax_total: type: string display_refund_tax_total: type: string approved_at: type: string nullable: true received_at: type: string nullable: true refunded_at: type: string nullable: true canceled_at: type: string nullable: true reason: $ref: '#/components/schemas/ReturnReason' return_line_items: type: array items: $ref: '#/components/schemas/ReturnLineItem' memo: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string stock_location_id: type: string nullable: true created_by_id: type: string nullable: true created_by_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. created_by: $ref: '#/components/schemas/Actor' refunded_total: type: string display_refunded_total: type: string refundable_total: type: string order: $ref: '#/components/schemas/Order' stock_location: $ref: '#/components/schemas/StockLocation' refunds: type: array items: $ref: '#/components/schemas/Refund' documents: type: object labels: type: array items: $ref: '#/components/schemas/ShippingLabel' deliveries: type: array items: $ref: '#/components/schemas/Delivery' required: - id - number - status - order_id - reason_id - refund_total - display_refund_total - refund_tax_total - display_refund_tax_total - approved_at - received_at - refunded_at - canceled_at - memo - metadata - created_at - updated_at - stock_location_id - created_by_id - created_by_type - refunded_total - display_refunded_total - refundable_total - documents - labels - deliveries x-typelizer: true Exchange: type: object properties: id: type: string number: type: string status: anyOf: - type: string enum: - requested - approved - received - fulfilled - canceled - type: string description: The values listed are the built-in ones; extensions may add more. order_id: type: string nullable: true reason_id: type: string nullable: true price_difference: type: string display_price_difference: type: string approved_at: type: string nullable: true received_at: type: string nullable: true fulfilled_at: type: string nullable: true canceled_at: type: string nullable: true reason: $ref: '#/components/schemas/ReturnReason' exchange_line_items: type: array items: $ref: '#/components/schemas/ExchangeLineItem' memo: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string stock_location_id: type: string nullable: true created_by_id: type: string nullable: true created_by_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. created_by: $ref: '#/components/schemas/Actor' order: $ref: '#/components/schemas/Order' stock_location: $ref: '#/components/schemas/StockLocation' refunds: type: array items: $ref: '#/components/schemas/Refund' required: - id - number - status - order_id - reason_id - price_difference - display_price_difference - approved_at - received_at - fulfilled_at - canceled_at - memo - metadata - created_at - updated_at - stock_location_id - created_by_id - created_by_type x-typelizer: true Claim: type: object properties: id: type: string number: type: string status: anyOf: - type: string enum: - open - approved - resolved - denied - canceled - type: string description: The values listed are the built-in ones; extensions may add more. resolution: type: string nullable: true order_id: type: string nullable: true reason_id: type: string nullable: true refund_total: type: string display_refund_total: type: string approved_at: type: string nullable: true resolved_at: type: string nullable: true denied_at: type: string nullable: true canceled_at: type: string nullable: true reason: $ref: '#/components/schemas/ClaimReason' claim_line_items: type: array items: $ref: '#/components/schemas/ClaimLineItem' memo: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string created_by_id: type: string nullable: true created_by_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. created_by: $ref: '#/components/schemas/Actor' order: $ref: '#/components/schemas/Order' refunds: type: array items: $ref: '#/components/schemas/Refund' required: - id - number - status - resolution - order_id - reason_id - refund_total - display_refund_total - approved_at - resolved_at - denied_at - canceled_at - memo - metadata - created_at - updated_at - created_by_id - created_by_type x-typelizer: true FreightSummary: type: object properties: total_units: type: number total_cartons: type: number total_pallets: type: number nullable: true total_volume: type: string total_weight: type: string complete: type: boolean lines: type: array items: $ref: '#/components/schemas/FreightSummaryLine' required: - total_units - total_cartons - total_pallets - total_volume - total_weight - complete - lines x-typelizer: true AdminUser: type: object properties: id: type: string email: type: string first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string nullable: true selected_locale: type: string nullable: true created_at: type: string updated_at: type: string avatar_url: type: string nullable: true roles: type: array items: $ref: '#/components/schemas/AdminUserRoleAssignment' stores: type: array items: $ref: '#/components/schemas/AdminUserStore' required: - id - email - first_name - last_name - full_name - selected_locale - created_at - updated_at - avatar_url - roles - stores x-typelizer: true CompanyMembership: type: object properties: id: type: string company_id: type: string customer_id: type: string email: type: string nullable: true created_at: type: string updated_at: type: string required: - id - company_id - customer_id - email - 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 DigitalLink: type: object properties: id: type: string access_counter: type: number filename: type: string content_type: type: string download_url: type: string expires_at: type: string nullable: true authorizable: type: boolean expired: type: boolean access_limit_exceeded: type: boolean created_at: type: string updated_at: type: string required: - id - access_counter - filename - content_type - download_url - expires_at - authorizable - expired - access_limit_exceeded - created_at - updated_at x-typelizer: true TaxLine: type: object properties: id: type: string label: type: string included: type: boolean credit: type: boolean rate: type: string tax_rate_id: type: string nullable: true line_item_id: type: string nullable: true fulfillment_id: type: string nullable: true fee_id: type: string nullable: true return_line_item_id: type: string nullable: true claim_line_item_id: type: string nullable: true exchange_line_item_id: type: string nullable: true amount: type: string display_amount: type: string provider_id: type: string nullable: true metadata: type: object nullable: true taxability_reason: type: string nullable: true country_code: type: string nullable: true state_code: type: string nullable: true data: type: object nullable: true created_at: type: string updated_at: type: string original_tax_line_id: type: string nullable: true required: - id - label - included - credit - rate - tax_rate_id - line_item_id - fulfillment_id - fee_id - return_line_item_id - claim_line_item_id - exchange_line_item_id - amount - display_amount - provider_id - metadata - taxability_reason - country_code - state_code - data - created_at - updated_at - original_tax_line_id 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_price: type: string nullable: true cost_currency: type: string nullable: true barcode: type: string nullable: true backorder_limit: type: number nullable: true hs_code: type: string nullable: true country_of_origin: type: string nullable: true 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 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_price - cost_currency - barcode - backorder_limit - hs_code - country_of_origin - customs_description - carton_weight - cartons_per_pallet - deleted_at - created_at - updated_at - 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 TaxCategory: type: object properties: id: type: string name: type: string tax_code: type: string nullable: true description: type: string nullable: true is_default: type: boolean created_at: type: string updated_at: type: string required: - id - name - tax_code - description - is_default - created_at - updated_at x-typelizer: true FulfillmentManifestItem: type: object description: >- An item within a fulfillment — which line item and how many units are in this fulfillment properties: item_id: type: string description: Line item ID example: li_abc123 variant_id: type: string description: Variant ID example: variant_abc123 quantity: type: integer description: Quantity in this fulfillment example: 2 required: - item_id - variant_id - quantity Delivery: type: object properties: id: type: string tracking_number: type: string carrier: type: string nullable: true carrier_name: type: string nullable: true service: type: string nullable: true status: type: string enum: - pending - pre_transit - in_transit - out_for_delivery - available_for_pickup - delivered - return_to_sender - failure - unknown tracking_url: type: string nullable: true estimated_delivery_at: type: string nullable: true delivered_at: type: string nullable: true details: type: object nullable: true created_at: type: string updated_at: type: string shipping_label_id: type: string nullable: true required: - id - tracking_number - carrier - carrier_name - service - status - tracking_url - estimated_delivery_at - delivered_at - details - created_at - updated_at - shipping_label_id x-typelizer: true DeliveryMethod: type: object properties: id: type: string name: type: string code: type: string nullable: true estimated_transit_business_days_min: type: number nullable: true estimated_transit_business_days_max: type: number nullable: true digital: type: boolean pickup: type: boolean pickup_point: type: boolean admin_name: type: string nullable: true storefront_visible: type: boolean tracking_url: type: string nullable: true markup_flat: type: string nullable: true markup_percent: type: string nullable: true available_to_sellers: type: boolean created_at: type: string updated_at: type: string deleted_at: type: string seller_id: type: string nullable: true seller_name: type: string nullable: true services: type: array items: $ref: '#/components/schemas/DeliveryMethodService' rules: type: array items: $ref: '#/components/schemas/DeliveryMethodRule' tax_category_id: type: string nullable: true delivery_profile_id: type: string delivery_origin_group_id: type: string nullable: true delivery_zone_id: type: string nullable: true stock_location_ids: type: array items: type: string fulfillment_provider: type: string description: >- Fulfillment provider. Built-in: manual, digital, pickup, pickup_point. Provider gems register more (e.g. easy_post). pickup_point_provider: type: string nullable: true description: Pickup point network. None built in; provider gems register them. rate_provider: type: string nullable: true description: >- Rate provider; null prices through the calculator. Built-in: internal, freight. Provider gems register more (e.g. easy_post). calculator_type: type: string nullable: true calculator_preferences: type: object nullable: true required: - id - name - code - estimated_transit_business_days_min - estimated_transit_business_days_max - digital - pickup - pickup_point - admin_name - storefront_visible - tracking_url - markup_flat - markup_percent - available_to_sellers - created_at - updated_at - deleted_at - seller_id - seller_name - services - rules - tax_category_id - delivery_profile_id - delivery_origin_group_id - delivery_zone_id - stock_location_ids - fulfillment_provider - pickup_point_provider - rate_provider - calculator_type - calculator_preferences x-typelizer: true DeliveryRate: type: object properties: id: type: string delivery_method_id: type: string name: type: string selected: type: boolean cost: type: string total: type: string additional_tax_total: type: string included_tax_total: type: string tax_total: type: string carrier: type: string nullable: true service_level: type: string nullable: true estimated_delivery_date: type: string nullable: true unpriced: type: boolean freight_summary: allOf: - $ref: '#/components/schemas/FreightSummary' nullable: true display_cost: type: string display_total: type: string display_additional_tax_total: type: string display_included_tax_total: type: string display_tax_total: type: string delivery_method: $ref: '#/components/schemas/DeliveryMethod' metadata: type: object nullable: true created_at: type: string updated_at: type: string required: - id - delivery_method_id - name - selected - cost - total - additional_tax_total - included_tax_total - tax_total - carrier - service_level - estimated_delivery_date - unpriced - freight_summary - display_cost - display_total - display_additional_tax_total - display_included_tax_total - display_tax_total - metadata - created_at - updated_at x-typelizer: true ShippingLabel: type: object properties: id: type: string source: type: string enum: - purchased - uploaded status: anyOf: - type: string enum: - purchased - refund_requested - refunded - type: string description: The values listed are the built-in ones; extensions may add more. carrier: type: string nullable: true carrier_name: type: string nullable: true service: type: string nullable: true tracking_number: type: string nullable: true currency: type: string nullable: true format: type: string nullable: true external_id: type: string nullable: true metadata: type: object refunded_at: type: string nullable: true created_at: type: string updated_at: type: string owner_id: type: string owner_type: type: string enum: - fulfillment - return cost: type: string display_cost: type: string integration_id: type: string nullable: true file_pending: type: boolean download_url: type: string nullable: true required: - id - source - status - carrier - carrier_name - service - tracking_number - currency - format - external_id - metadata - refunded_at - created_at - updated_at - owner_id - owner_type - cost - display_cost - integration_id - file_pending - download_url x-typelizer: true FulfillmentItem: type: object properties: id: type: string quantity: type: number status: anyOf: - type: string enum: - on_hand - backordered - shipped - returned - type: string description: The values listed are the built-in ones; extensions may add more. variant_id: type: string nullable: true line_item_id: type: string nullable: true name: type: string nullable: true options_text: type: string nullable: true required: - id - quantity - status - variant_id - line_item_id - name - options_text x-typelizer: true CreditCard: type: object properties: id: type: string brand: type: string last4: type: string month: type: number year: type: number name: type: string nullable: true default: type: boolean gateway_payment_profile_id: type: string nullable: true customer_id: type: string nullable: true payment_method_id: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string required: - id - brand - last4 - month - year - name - default - gateway_payment_profile_id - customer_id - payment_method_id - metadata - created_at - updated_at x-typelizer: true PaymentSource: type: object properties: id: type: string gateway_payment_profile_id: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string required: - id - gateway_payment_profile_id - metadata - created_at - updated_at x-typelizer: true Refund: type: object properties: id: type: string transaction_id: type: string nullable: true amount: type: string nullable: true payment_id: type: string nullable: true refund_reason_id: type: string nullable: true originator_id: type: string nullable: true originator_type: type: string nullable: true metadata: type: object created_at: type: string updated_at: type: string tax_amount: type: string refunder_id: type: string nullable: true refunder_type: anyOf: - type: string enum: - admin_user - api_key - type: string nullable: true description: The values listed are the built-in ones; extensions may add more. refunder: $ref: '#/components/schemas/Actor' payment: $ref: '#/components/schemas/Payment' required: - id - transaction_id - amount - payment_id - refund_reason_id - originator_id - originator_type - metadata - created_at - updated_at - tax_amount - refunder_id - refunder_type x-typelizer: true GiftCardBatch: type: object properties: id: type: string codes_count: type: number currency: type: string nullable: true prefix: type: string nullable: true created_at: type: string updated_at: type: string amount: type: string nullable: true expires_at: type: string nullable: true created_by_id: type: string nullable: true required: - id - codes_count - currency - prefix - created_at - updated_at - amount - expires_at - created_by_id x-typelizer: true CartWarning: type: object description: A warning about a cart issue (e.g., item removed due to stock change) properties: code: type: string description: Machine-readable warning code example: line_item_removed message: type: string description: Human-readable warning message example: Blue T-Shirt was removed because it was sold out line_item_id: type: string nullable: true description: Prefixed line item ID (when applicable) example: li_abc123 variant_id: type: string nullable: true description: Prefixed variant ID (when applicable) example: variant_abc123 item_index: type: integer nullable: true description: >- Position in the submitted items array, for warnings raised while applying a batch of item changes example: 1 required: - code - message CheckoutRequirement: type: object properties: step: type: string description: Checkout step this requirement belongs to example: payment field: type: string description: Field that needs to be satisfied example: payment message: type: string description: Human-readable requirement message example: Add a payment method required: - step - field - message ReturnReason: type: object properties: id: type: string name: type: string active: type: boolean created_at: type: string updated_at: type: string can_be_deleted: type: boolean required: - id - name - active - created_at - updated_at - can_be_deleted x-typelizer: true ReturnLineItem: type: object properties: id: type: string quantity: type: number received_quantity: type: number resellable: type: boolean pre_tax_amount: type: string display_pre_tax_amount: type: string included_tax_total: type: string additional_tax_total: type: string tax_total: type: string display_tax_total: type: string refund_amount: type: string display_refund_amount: type: string variant_id: type: string nullable: true line_item_id: type: string nullable: true fulfillment_item_id: type: string nullable: true variant: $ref: '#/components/schemas/Variant' created_at: type: string updated_at: type: string line_item: $ref: '#/components/schemas/LineItem' tax_lines: type: array items: $ref: '#/components/schemas/TaxLine' required: - id - quantity - received_quantity - resellable - pre_tax_amount - display_pre_tax_amount - included_tax_total - additional_tax_total - tax_total - display_tax_total - refund_amount - display_refund_amount - variant_id - line_item_id - fulfillment_item_id - created_at - updated_at x-typelizer: true ExchangeLineItem: type: object properties: id: type: string quantity: type: number received_quantity: type: number resellable: type: boolean original_price: type: string new_variant_price: type: string price_difference: type: string original_tax_total: type: string new_tax_total: type: string original_variant_id: type: string nullable: true new_variant_id: type: string nullable: true line_item_id: type: string nullable: true fulfillment_item_id: type: string nullable: true original_variant: $ref: '#/components/schemas/Variant' new_variant: $ref: '#/components/schemas/Variant' created_at: type: string updated_at: type: string required: - id - quantity - received_quantity - resellable - original_price - new_variant_price - price_difference - original_tax_total - new_tax_total - original_variant_id - new_variant_id - line_item_id - fulfillment_item_id - created_at - updated_at x-typelizer: true ClaimReason: type: object properties: id: type: string name: type: string active: type: boolean created_at: type: string updated_at: type: string can_be_deleted: type: boolean required: - id - name - active - created_at - updated_at - can_be_deleted x-typelizer: true ClaimLineItem: type: object properties: id: type: string quantity: type: number send_replacement: type: boolean description: type: string nullable: true refund_amount: type: string paid_amount: type: string pre_tax_amount: type: string included_tax_total: type: string additional_tax_total: type: string tax_total: type: string display_refund_amount: type: string variant_id: type: string nullable: true replacement_variant_id: type: string nullable: true line_item_id: type: string nullable: true variant: $ref: '#/components/schemas/Variant' created_at: type: string updated_at: type: string replacement_variant: $ref: '#/components/schemas/Variant' required: - id - quantity - send_replacement - description - refund_amount - paid_amount - pre_tax_amount - included_tax_total - additional_tax_total - tax_total - display_refund_amount - variant_id - replacement_variant_id - line_item_id - created_at - updated_at x-typelizer: true FreightSummaryLine: type: object properties: variant_id: type: string nullable: true sku: type: string nullable: true name: type: string nullable: true units: type: number cartons: type: number nullable: true pallets: type: number nullable: true units_per_carton: type: number nullable: true cartons_per_pallet: type: number nullable: true complete: type: boolean weight_per_carton: type: string nullable: true volume: type: string weight: type: string required: - variant_id - sku - name - units - cartons - pallets - units_per_carton - cartons_per_pallet - complete - weight_per_carton - volume - weight x-typelizer: true AdminUserRoleAssignment: type: object description: A role assignment for the current store on a staff member properties: id: type: string description: Prefixed role ID example: role_abc123 name: type: string description: Role name example: admin required: - id - name AdminUserStore: type: object description: A store the staff member can access through a role assignment properties: id: type: string description: Prefixed store ID example: store_abc123 name: type: string description: Store name example: My Store code: type: string description: Store code example: my-store required: - id - name - code 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 Price: type: object properties: id: type: string amount: type: string nullable: true amount_in_cents: type: number nullable: true compare_at_amount: type: string nullable: true compare_at_amount_in_cents: type: number nullable: true currency: type: string nullable: true display_amount: type: string nullable: true display_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 - amount - amount_in_cents - compare_at_amount - compare_at_amount_in_cents - currency - display_amount - display_compare_at_amount - price_list_id - min_quantity - variant_id - created_at - updated_at 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 focal_point_x: type: number nullable: true focal_point_y: type: number nullable: true external_video_url: type: string 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 - focal_point_x - focal_point_y - external_video_url - 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 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: type: object 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 amount: type: string amount_in_cents: type: number currency: type: string display_amount: type: string 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 - amount - amount_in_cents - currency - display_amount - recorded_at - variant_id - price_id - compare_at_amount - 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 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 DeliveryMethodService: type: object properties: id: type: string carrier: type: string service: type: string label: type: string nullable: true markup_flat: type: string nullable: true markup_percent: type: string nullable: true position: type: number required: - id - carrier - service - label - markup_flat - markup_percent - position x-typelizer: true DeliveryMethodRule: type: object properties: id: type: string active: type: boolean created_at: type: string updated_at: type: string type: type: string description: >- Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule, channel_rule, volume_rule, company_rule. Extensions may register more. preferences: type: object preference_schema: type: object product_ids: type: array items: type: string required: - id - active - created_at - updated_at - type - preferences - preference_schema - product_ids 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.