> ## 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 an order > One order, as the seller needs it to pack and post the parcel: the lines with their SKUs, where it ships to, and a fulfillment per parcel. How the customer paid the marketplace is deliberately absent — that is between the buyer and the operator. ## OpenAPI ````yaml /api-reference/seller.yaml get /api/v3/seller/orders/{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/orders/{id}: parameters: - name: id in: path description: Prefixed order ID required: true schema: type: string get: tags: - Orders summary: Get an order description: | One order, as the seller needs it to pack and post the parcel: the lines with their SKUs, where it ships to, and a fulfillment per parcel. How the customer paid the marketplace is deliberately absent — that is between the buyer and the operator. parameters: - name: X-Spree-Seller-Id in: header required: true schema: type: string responses: '200': description: order found content: application/json: example: id: or_UkLWZg9DAJ number: R1001 customer_note: null currency: USD total_quantity: 1 status: placed fulfillment_status: null payment_status: null completed_at: '2026-01-15T12:00:00.000Z' created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' internal_note: null internal_note_html: null item_total: '10.00' delivery_total: '100.00' discount_total: '0.00' adjustment_total: '0.00' included_tax_total: '0.00' additional_tax_total: '0.00' tax_total: '0.00' total: '110.00' payment_total: '0.00' amount_due: '110.00' commission_amount_total: '0.00' commission_tax_total: '0.00' commission_total: '0.00' canceled_at: null cancel_reason_name: null cancel_note: null items: - id: li_UkLWZg9DAJ name: Product 2719755 options_text: '' quantity: 1 currency: USD price: '10.00' discounted_amount: '10.00' additional_tax_total: '0.00' total: '10.00' variant_id: variant_UkLWZg9DAJ sku: SKU-357 thumbnail_url: null fulfillments: - id: ful_UkLWZg9DAJ number: R1001-F1 status: unfulfilled tracking: U10000 tracking_url: null fulfilled_at: null delivered_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' fulfillment_type: shipping delivery_method_name: UPS Ground 147 stock_location_name: Woodrow Hand stock_location_id: sloc_UkLWZg9DAJ fulfillment_items: - id: fi_UkLWZg9DAJ quantity: 1 line_item_id: li_UkLWZg9DAJ variant_id: variant_UkLWZg9DAJ name: Product 2719755 sku: SKU-357 options_text: '' selected_delivery_rate_id: dr_gbHJdmfrXB delivery_rates: - id: dr_gbHJdmfrXB name: UPS Ground 147 selected: true cost: '10.00' total: '10.00' carrier: null service_level: null estimated_delivery_date: null unpriced: false deliveries: - id: dlv_UkLWZg9DAJ tracking_number: U10000 carrier: null carrier_name: null service: null status: pending tracking_url: null estimated_delivery_at: null delivered_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' shipping_label_id: null labels: [] shipping_address: id: addr_gbHJdmfrXB label: null first_name: John last_name: Doe full_name: John Doe address1: 284 Lovely Street address2: Northwest postal_code: '10118' city: New York phone: 555-555-0199 company: Company country_name: United States country_code: US state_text: NY state_code: NY quick_checkout: false is_default_billing: false is_default_shipping: false state_name: New York billing_address: id: addr_UkLWZg9DAJ label: null first_name: John last_name: Doe full_name: John Doe address1: 283 Lovely Street address2: Northwest postal_code: '10118' city: New York phone: 555-555-0199 company: Company country_name: United States country_code: US state_text: NY state_code: NY quick_checkout: false is_default_billing: false is_default_shipping: false state_name: New York schema: $ref: '#/components/schemas/Order' '404': description: another seller's order content: application/json: example: error: code: order_not_found message: Order not found schema: $ref: '#/components/schemas/ErrorResponse' 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 order = await client.orders.get('or_UkLWZg9DAJ', { expand: ['payment_splits'] }) components: schemas: Order: type: object properties: id: type: string number: type: string customer_note: type: string nullable: true 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 total_quantity: type: number status: type: string enum: - draft - placed - canceled 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 created_at: type: string updated_at: type: string internal_note: type: string nullable: true internal_note_html: type: string nullable: true item_total: type: string nullable: true delivery_total: type: string nullable: true discount_total: type: string nullable: true adjustment_total: type: string nullable: true included_tax_total: type: string nullable: true additional_tax_total: type: string nullable: true tax_total: type: string nullable: true total: type: string nullable: true payment_total: type: string nullable: true amount_due: type: string nullable: true commission_amount_total: type: string nullable: true commission_tax_total: type: string nullable: true commission_total: type: string nullable: true canceled_at: type: string nullable: true cancel_reason_name: type: string nullable: true cancel_note: type: string nullable: true items: type: array items: $ref: '#/components/schemas/OrderLineItem' payment_splits: type: array items: $ref: '#/components/schemas/PaymentSplit' fulfillments: type: array items: $ref: '#/components/schemas/Fulfillment' shipping_address: $ref: '#/components/schemas/Address' billing_address: $ref: '#/components/schemas/Address' required: - id - number - customer_note - currency - total_quantity - status - fulfillment_status - payment_status - completed_at - created_at - updated_at - internal_note - internal_note_html - item_total - delivery_total - discount_total - adjustment_total - included_tax_total - additional_tax_total - tax_total - total - payment_total - amount_due - commission_amount_total - commission_tax_total - commission_total - canceled_at - cancel_reason_name - cancel_note - items - fulfillments - shipping_address - billing_address 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 OrderLineItem: type: object properties: id: type: string name: type: string options_text: type: string nullable: true quantity: type: number 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 price: type: string nullable: true discounted_amount: type: string nullable: true additional_tax_total: type: string nullable: true total: type: string nullable: true variant_id: type: string nullable: true sku: type: string nullable: true thumbnail_url: type: string nullable: true required: - id - name - options_text - quantity - currency - price - discounted_amount - additional_tax_total - total - variant_id - sku - thumbnail_url x-typelizer: true PaymentSplit: 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 created_at: type: string authorized_amount: type: string captured_amount: type: string refunded_amount: type: string claimed_amount: type: string net_captured_amount: type: string refundable_amount: type: string required: - id - currency - created_at - authorized_amount - captured_amount - refunded_amount - claimed_amount - net_captured_amount - refundable_amount x-typelizer: true Fulfillment: type: object properties: id: type: string number: 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. tracking: type: string nullable: true tracking_url: type: string nullable: true fulfilled_at: type: string nullable: true delivered_at: type: string nullable: true created_at: type: string updated_at: type: string fulfillment_type: type: string nullable: true delivery_method_name: type: string nullable: true stock_location_name: type: string nullable: true stock_location_id: type: string nullable: true fulfillment_items: type: array items: $ref: '#/components/schemas/FulfillmentItem' selected_delivery_rate_id: type: string nullable: true delivery_rates: type: array items: $ref: '#/components/schemas/DeliveryRate' deliveries: type: array items: $ref: '#/components/schemas/Delivery' labels: type: array items: $ref: '#/components/schemas/ShippingLabel' required: - id - number - status - tracking - tracking_url - fulfilled_at - delivered_at - created_at - updated_at - fulfillment_type - delivery_method_name - stock_location_name - stock_location_id - fulfillment_items - selected_delivery_rate_id - delivery_rates - deliveries - labels x-typelizer: true Address: type: object properties: id: type: string label: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string address1: type: string nullable: true address2: type: string nullable: true postal_code: type: string nullable: true city: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true country_name: type: string country_code: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW state_text: type: string nullable: true state_code: type: string nullable: true quick_checkout: type: boolean is_default_billing: type: boolean is_default_shipping: type: boolean state_name: type: string nullable: true required: - id - label - first_name - last_name - full_name - address1 - address2 - postal_code - city - phone - company - country_name - country_code - state_text - state_code - quick_checkout - is_default_billing - is_default_shipping - state_name x-typelizer: true FulfillmentItem: type: object properties: id: type: string quantity: type: number line_item_id: type: string nullable: true variant_id: type: string nullable: true name: type: string nullable: true sku: type: string nullable: true options_text: type: string nullable: true required: - id - quantity - line_item_id - variant_id - name - sku - options_text x-typelizer: true DeliveryRate: type: object properties: id: type: string name: type: string selected: type: boolean cost: type: string total: type: string carrier: type: string nullable: true service_level: type: string nullable: true estimated_delivery_date: type: string nullable: true unpriced: type: boolean required: - id - name - selected - cost - total - carrier - service_level - estimated_delivery_date - unpriced x-typelizer: true 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 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 - created_at - updated_at - shipping_label_id 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 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 format: type: string nullable: true enum: - pdf - png - zpl 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 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 - integration_id - file_pending - download_url 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.