List exchanges

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: exchanges } = await client.orders.exchanges.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "exch_UkLWZg9DAJ",
      "number": "EX1001",
      "status": "requested",
      "order_id": "or_UkLWZg9DAJ",
      "reason_id": null,
      "price_difference": "9.99",
      "approved_at": null,
      "received_at": null,
      "fulfilled_at": null,
      "canceled_at": null,
      "memo": null,
      "stock_location_id": "sloc_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

seller

orders

{order_id}

exchanges

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: exchanges } = await client.orders.exchanges.list('or_UkLWZg9DAJ')

{
  "data": [
    {
      "id": "exch_UkLWZg9DAJ",
      "number": "EX1001",
      "status": "requested",
      "order_id": "or_UkLWZg9DAJ",
      "reason_id": null,
      "price_difference": "9.99",
      "approved_at": null,
      "received_at": null,
      "fulfilled_at": null,
      "canceled_at": null,
      "memo": null,
      "stock_location_id": "sloc_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[number_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`number`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`status`	One of `requested`, `approved`, `received`, `fulfilled`, `canceled`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: created_at, id, number, status, updated_at. Prefix a field with - to sort descending.

Authorizations

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Path Parameters

order_id

string

required

Prefixed order ID

Query Parameters

q[search]

string

Matches any of number (partial, case-insensitive).

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

exchanges listed

data

object[]

required

Show child attributes

⌘I

API basics

Endpoints

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters