GET
/
admin
/
exchanges
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.exchange.list()
.then(({ exchanges, count, limit, offset }) => {
  console.log(exchanges)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "exchanges": [
    {
      "order_id": "<string>",
      "return_items": [
        {
          "id": "<string>",
          "quantity": 123,
          "received_quantity": 123,
          "damaged_quantity": 123,
          "reason_id": "<string>",
          "note": "<string>",
          "item_id": "<string>",
          "return_id": "<string>",
          "metadata": {}
        }
      ],
      "additional_items": [
        {
          "id": "<string>",
          "exchange_id": "<string>",
          "order_id": "<string>",
          "item_id": "<string>",
          "quantity": 123,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "no_notification": true,
      "difference_due": 123,
      "return": {
        "id": "<string>",
        "status": "canceled",
        "refund_amount": 123,
        "order_id": "<string>",
        "items": [
          {
            "id": "<string>",
            "quantity": 123,
            "received_quantity": 123,
            "damaged_quantity": 123,
            "reason_id": "<string>",
            "note": "<string>",
            "item_id": "<string>",
            "return_id": "<string>",
            "metadata": {}
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "canceled_at": "2023-11-07T05:31:56Z",
        "exchange_id": "<string>",
        "location_id": "<string>",
        "claim_id": "<string>",
        "order_version": 123,
        "display_id": 123,
        "no_notification": true,
        "received_at": "<string>"
      },
      "return_id": "<string>",
      "id": "<string>",
      "display_id": "<string>",
      "shipping_methods": [
        {
          "id": "<string>",
          "order_id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "amount": 123,
          "is_tax_inclusive": true,
          "shipping_option_id": "<string>",
          "data": {},
          "metadata": {},
          "tax_lines": [
            {
              "shipping_method": "<any>",
              "shipping_method_id": "<any>",
              "total": "<any>",
              "subtotal": "<any>",
              "id": "<any>",
              "description": "<any>",
              "tax_rate_id": "<any>",
              "code": "<any>",
              "rate": "<any>",
              "provider_id": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>"
            }
          ],
          "adjustments": [
            {
              "shipping_method": "<any>",
              "shipping_method_id": "<any>",
              "id": "<any>",
              "code": "<any>",
              "amount": "<any>",
              "order_id": "<any>",
              "description": "<any>",
              "promotion_id": "<any>",
              "provider_id": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>"
            }
          ],
          "original_total": 123,
          "original_subtotal": 123,
          "original_tax_total": 123,
          "total": 123,
          "subtotal": 123,
          "tax_total": 123,
          "discount_total": 123,
          "discount_tax_total": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "detail": {
            "id": "<string>",
            "shipping_method_id": "<string>",
            "shipping_method": {},
            "claim_id": "<string>",
            "exchange_id": "<string>",
            "return_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "transactions": [
        {
          "id": "<string>",
          "order_id": "<string>",
          "amount": 123,
          "currency_code": "usd",
          "reference": "capture",
          "reference_id": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "order_version": "<string>",
      "created_by": "<string>",
      "canceled_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "order": {
        "payment_collections": [
          {
            "id": "<string>",
            "currency_code": "<string>",
            "amount": 123,
            "authorized_amount": 123,
            "captured_amount": 123,
            "refunded_amount": 123,
            "completed_at": "2023-11-07T05:31:56Z",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "metadata": {},
            "status": "canceled",
            "payment_providers": [
              {
                "id": "<string>"
              }
            ],
            "payment_sessions": [
              {
                "id": "<string>",
                "amount": 123,
                "currency_code": "usd",
                "provider_id": "<string>",
                "data": {},
                "context": {
                  "customer": {
                    "id": "cus_123"
                  }
                },
                "status": "error",
                "authorized_at": "2023-11-07T05:31:56Z",
                "payment_collection": {},
                "payment": {
                  "id": "<string>",
                  "amount": 123,
                  "authorized_amount": 123,
                  "currency_code": "<string>",
                  "provider_id": "<string>",
                  "data": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "captured_at": "2023-11-07T05:31:56Z",
                  "canceled_at": "2023-11-07T05:31:56Z",
                  "captured_amount": 123,
                  "refunded_amount": 123,
                  "captures": [
                    "<any>"
                  ],
                  "refunds": [
                    "<any>"
                  ],
                  "payment_collection": {},
                  "payment_session": {}
                }
              }
            ],
            "payments": [
              {
                "id": "<string>",
                "amount": 123,
                "authorized_amount": 123,
                "currency_code": "<string>",
                "provider_id": "<string>",
                "data": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "captured_at": "2023-11-07T05:31:56Z",
                "canceled_at": "2023-11-07T05:31:56Z",
                "captured_amount": 123,
                "refunded_amount": 123,
                "captures": [
                  "<any>"
                ],
                "refunds": [
                  "<any>"
                ],
                "payment_collection": {},
                "payment_session": {}
              }
            ]
          }
        ],
        "fulfillments": [
          {
            "id": "<string>",
            "location_id": "<string>",
            "packed_at": "2023-11-07T05:31:56Z",
            "shipped_at": "2023-11-07T05:31:56Z",
            "delivered_at": "2023-11-07T05:31:56Z",
            "canceled_at": "2023-11-07T05:31:56Z",
            "data": {},
            "provider_id": "<string>",
            "shipping_option_id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "requires_shipping": true
          }
        ],
        "shipping_address": {
          "id": "<string>",
          "customer_id": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "phone": "<string>",
          "company": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "country_code": "us",
          "province": "us-ca",
          "postal_code": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "billing_address": {
          "id": "<string>",
          "customer_id": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "phone": "<string>",
          "company": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "country_code": "us",
          "province": "us-ca",
          "postal_code": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "version": 123,
        "region_id": "<string>",
        "customer_id": "<string>",
        "sales_channel_id": "<string>",
        "email": "jsmith@example.com",
        "currency_code": "<string>",
        "display_id": 123,
        "items": [
          {
            "id": "<string>",
            "title": "<string>",
            "subtitle": "<string>",
            "thumbnail": "<string>",
            "variant": {
              "id": "<string>",
              "title": "<string>",
              "sku": "<string>",
              "barcode": "<string>",
              "ean": "<string>",
              "upc": "<string>",
              "allow_backorder": true,
              "manage_inventory": true,
              "inventory_quantity": 123,
              "hs_code": "<string>",
              "origin_country": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "weight": 123,
              "length": 123,
              "height": 123,
              "width": 123,
              "variant_rank": 123,
              "options": [
                {
                  "id": "<string>",
                  "value": "<string>",
                  "option": {},
                  "option_id": "<string>",
                  "metadata": {},
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z"
                }
              ],
              "product": {
                "collection": {
                  "id": "<string>",
                  "title": "<string>",
                  "handle": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "products": [
                    "<any>"
                  ],
                  "metadata": {}
                },
                "categories": [
                  {}
                ],
                "variants": [
                  {}
                ],
                "type": {
                  "id": "<string>",
                  "value": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z",
                  "metadata": {}
                },
                "tags": [
                  {}
                ],
                "length": 123,
                "title": "<string>",
                "status": "draft",
                "options": [
                  {}
                ],
                "description": "<string>",
                "id": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "handle": "<string>",
                "subtitle": "<string>",
                "is_giftcard": true,
                "thumbnail": "<string>",
                "width": 123,
                "weight": 123,
                "height": 123,
                "origin_country": "<string>",
                "hs_code": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "collection_id": "<string>",
                "type_id": "<string>",
                "images": [
                  {}
                ],
                "discountable": true,
                "external_id": "<string>",
                "deleted_at": "2023-11-07T05:31:56Z"
              },
              "product_id": "<string>",
              "calculated_price": {
                "id": "<string>",
                "is_calculated_price_price_list": true,
                "is_calculated_price_tax_inclusive": true,
                "calculated_amount": 123,
                "calculated_amount_with_tax": 123,
                "calculated_amount_without_tax": 123,
                "is_original_price_price_list": true,
                "is_original_price_tax_inclusive": true,
                "original_amount": 123,
                "currency_code": "usd",
                "calculated_price": {},
                "original_price": {},
                "original_amount_with_tax": 123,
                "original_amount_without_tax": 123
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "metadata": {}
            },
            "variant_id": "<string>",
            "product": {
              "collection": {
                "id": "<string>",
                "title": "<string>",
                "handle": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "products": [
                  "<any>"
                ],
                "metadata": {}
              },
              "categories": [
                {}
              ],
              "variants": [
                {}
              ],
              "type": {
                "id": "<string>",
                "value": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "tags": [
                {}
              ],
              "length": 123,
              "title": "<string>",
              "status": "draft",
              "options": [
                {}
              ],
              "description": "<string>",
              "id": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "handle": "<string>",
              "subtitle": "<string>",
              "is_giftcard": true,
              "thumbnail": "<string>",
              "width": 123,
              "weight": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "collection_id": "<string>",
              "type_id": "<string>",
              "images": [
                {}
              ],
              "discountable": true,
              "external_id": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z"
            },
            "product_id": "<string>",
            "product_title": "<string>",
            "product_description": "<string>",
            "product_subtitle": "<string>",
            "product_type": "<string>",
            "product_collection": "<string>",
            "product_handle": "<string>",
            "variant_sku": "<string>",
            "variant_barcode": "<string>",
            "variant_title": "<string>",
            "variant_option_values": {
              "Color": "Blue"
            },
            "requires_shipping": true,
            "is_discountable": true,
            "is_tax_inclusive": true,
            "compare_at_unit_price": 123,
            "unit_price": 123,
            "quantity": 123,
            "tax_lines": [
              {
                "item": {},
                "item_id": "<string>",
                "total": 123,
                "subtotal": 123,
                "id": "<string>",
                "description": "<string>",
                "tax_rate_id": "<string>",
                "code": "<string>",
                "rate": 123,
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "adjustments": [
              {
                "item": {},
                "item_id": "<string>",
                "id": "<string>",
                "code": "<string>",
                "amount": 123,
                "order_id": "<string>",
                "description": "<string>",
                "promotion_id": "<string>",
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "detail": {
              "id": "<string>",
              "item_id": "<string>",
              "item": {},
              "quantity": 123,
              "fulfilled_quantity": 123,
              "delivered_quantity": 123,
              "shipped_quantity": 123,
              "return_requested_quantity": 123,
              "return_received_quantity": 123,
              "return_dismissed_quantity": 123,
              "written_off_quantity": 123,
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "metadata": {},
            "original_total": 123,
            "original_subtotal": 123,
            "original_tax_total": 123,
            "item_total": 123,
            "item_subtotal": 123,
            "item_tax_total": 123,
            "total": 123,
            "subtotal": 123,
            "tax_total": 123,
            "discount_total": 123,
            "discount_tax_total": 123,
            "refundable_total": 123,
            "refundable_total_per_unit": 123,
            "product_type_id": "<string>"
          }
        ],
        "shipping_methods": [
          {
            "id": "<string>",
            "order_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "amount": 123,
            "is_tax_inclusive": true,
            "shipping_option_id": "<string>",
            "data": {},
            "metadata": {},
            "tax_lines": [
              {
                "shipping_method": "<any>",
                "shipping_method_id": "<any>",
                "total": "<any>",
                "subtotal": "<any>",
                "id": "<any>",
                "description": "<any>",
                "tax_rate_id": "<any>",
                "code": "<any>",
                "rate": "<any>",
                "provider_id": "<any>",
                "created_at": "<any>",
                "updated_at": "<any>"
              }
            ],
            "adjustments": [
              {
                "shipping_method": "<any>",
                "shipping_method_id": "<any>",
                "id": "<any>",
                "code": "<any>",
                "amount": "<any>",
                "order_id": "<any>",
                "description": "<any>",
                "promotion_id": "<any>",
                "provider_id": "<any>",
                "created_at": "<any>",
                "updated_at": "<any>"
              }
            ],
            "original_total": 123,
            "original_subtotal": 123,
            "original_tax_total": 123,
            "total": 123,
            "subtotal": 123,
            "tax_total": 123,
            "discount_total": 123,
            "discount_tax_total": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "detail": {
              "id": "<string>",
              "shipping_method_id": "<string>",
              "shipping_method": {},
              "claim_id": "<string>",
              "exchange_id": "<string>",
              "return_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          }
        ],
        "payment_status": "canceled",
        "fulfillment_status": "canceled",
        "transactions": [
          {
            "id": "<string>",
            "order_id": "<string>",
            "amount": 123,
            "currency_code": "usd",
            "reference": "capture",
            "reference_id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "summary": {
          "paid_total": 123,
          "refunded_total": 123,
          "pending_difference": 123,
          "current_order_total": 123,
          "original_order_total": 123,
          "transaction_total": 123,
          "accounting_total": 123
        },
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "original_item_total": 123,
        "original_item_subtotal": 123,
        "original_item_tax_total": 123,
        "item_total": 123,
        "item_subtotal": 123,
        "item_tax_total": 123,
        "original_total": 123,
        "original_subtotal": 123,
        "original_tax_total": 123,
        "total": 123,
        "subtotal": 123,
        "tax_total": 123,
        "discount_total": 123,
        "discount_tax_total": 123,
        "gift_card_total": 123,
        "gift_card_tax_total": 123,
        "shipping_total": 123,
        "shipping_subtotal": 123,
        "shipping_tax_total": 123,
        "original_shipping_total": 123,
        "original_shipping_subtotal": 123,
        "original_shipping_tax_total": 123,
        "status": "<string>",
        "credit_line_total": 123
      },
      "allow_backorder": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
deleted_at
object

Filter by an exchange's deletion date.

​
id

Filter by an exchange ID.

​
order_id

Filter by an exchange's order ID.

​
status

Filter by an exchange's status.

​
created_at
object

Filter by the exchange's creation date.

​
updated_at
object

Filter by the exchange's update date.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of exchanges.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total number of items.

​
exchanges
object[]
required

The exchange's exchanges.