Skip to main content
POST
/
admin
/
returns
/
{id}
/
shipping-method
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.return.addReturnShipping("return_123", {
  shipping_option_id: "so_123",
})
.then(({ return }) => {
  console.log(return)
})
{
  "order_preview": {
    "return_requested_total": 123,
    "order_change": {
      "id": "<string>",
      "version": 123,
      "change_type": "return",
      "order_id": "<string>",
      "return_id": "<string>",
      "exchange_id": "<string>",
      "claim_id": "<string>",
      "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": [
              "<any>"
            ],
            "payment_sessions": [
              "<any>"
            ],
            "payments": [
              "<any>"
            ]
          }
        ],
        "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
          }
        ],
        "sales_channel": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "is_disabled": true,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "customer": {
          "id": "<string>",
          "has_account": true,
          "groups": [
            {}
          ],
          "email": "jsmith@example.com",
          "default_billing_address_id": "<string>",
          "default_shipping_address_id": "<string>",
          "company_name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "addresses": [
            {}
          ],
          "phone": "<string>",
          "metadata": {},
          "created_by": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "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",
          "country": {
            "id": "<string>",
            "iso_2": "us",
            "iso_3": "usa",
            "num_code": 840,
            "name": "<string>",
            "display_name": "<string>"
          },
          "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",
          "country": {
            "id": "<string>",
            "iso_2": "us",
            "iso_3": "usa",
            "num_code": 840,
            "name": "<string>",
            "display_name": "<string>"
          },
          "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": {},
            "variant_id": "<string>",
            "product": {},
            "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": [
              "<any>"
            ],
            "adjustments": [
              "<any>"
            ],
            "detail": {},
            "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": [
              "<any>"
            ],
            "adjustments": [
              "<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": {}
          }
        ],
        "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>",
        "region": {
          "id": "<string>",
          "name": "<string>",
          "currency_code": "usd",
          "automatic_taxes": true,
          "countries": [
            {}
          ],
          "payment_providers": [
            {}
          ],
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "credit_lines": [
          {
            "id": "<string>",
            "order_id": "<string>",
            "order": {},
            "reference": "<string>",
            "reference_id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "amount": 123
          }
        ],
        "credit_line_total": 123
      },
      "return_order": {
        "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>"
      },
      "exchange": {
        "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": "<any>",
                    "amount": "<any>",
                    "authorized_amount": "<any>",
                    "currency_code": "<any>",
                    "provider_id": "<any>",
                    "data": "<any>",
                    "created_at": "<any>",
                    "updated_at": "<any>",
                    "captured_at": "<any>",
                    "canceled_at": "<any>",
                    "captured_amount": "<any>",
                    "refunded_amount": "<any>",
                    "captures": "<any>",
                    "refunds": "<any>",
                    "payment_collection": "<any>",
                    "payment_session": "<any>"
                  }
                }
              ],
              "payments": [
                {
                  "id": "<any>",
                  "amount": "<any>",
                  "authorized_amount": "<any>",
                  "currency_code": "<any>",
                  "provider_id": "<any>",
                  "data": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "captured_at": "<any>",
                  "canceled_at": "<any>",
                  "captured_amount": "<any>",
                  "refunded_amount": "<any>",
                  "captures": "<any>",
                  "refunds": "<any>",
                  "payment_collection": "<any>",
                  "payment_session": "<any>"
                }
              ]
            }
          ],
          "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": "<any>",
                    "title": "<any>",
                    "handle": "<any>",
                    "created_at": "<any>",
                    "updated_at": "<any>",
                    "deleted_at": "<any>",
                    "products": "<any>",
                    "metadata": "<any>"
                  },
                  "categories": [
                    "<any>"
                  ],
                  "variants": [
                    "<any>"
                  ],
                  "type": {
                    "id": "<any>",
                    "value": "<any>",
                    "created_at": "<any>",
                    "updated_at": "<any>",
                    "deleted_at": "<any>",
                    "metadata": "<any>"
                  },
                  "tags": [
                    "<any>"
                  ],
                  "length": 123,
                  "title": "<string>",
                  "status": "draft",
                  "options": [
                    "<any>"
                  ],
                  "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": [
                    "<any>"
                  ],
                  "discountable": true,
                  "external_id": "<string>",
                  "deleted_at": "2023-11-07T05:31:56Z"
                },
                "product_id": "<string>",
                "calculated_price": {
                  "id": "<any>",
                  "is_calculated_price_price_list": "<any>",
                  "is_calculated_price_tax_inclusive": "<any>",
                  "calculated_amount": "<any>",
                  "calculated_amount_with_tax": "<any>",
                  "calculated_amount_without_tax": "<any>",
                  "is_original_price_price_list": "<any>",
                  "is_original_price_tax_inclusive": "<any>",
                  "original_amount": "<any>",
                  "currency_code": "<any>",
                  "calculated_price": "<any>",
                  "original_price": "<any>",
                  "original_amount_with_tax": "<any>",
                  "original_amount_without_tax": "<any>"
                },
                "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": "<any>",
                  "title": "<any>",
                  "handle": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "deleted_at": "<any>",
                  "products": "<any>",
                  "metadata": "<any>"
                },
                "categories": [
                  "<any>"
                ],
                "variants": [
                  "<any>"
                ],
                "type": {
                  "id": "<any>",
                  "value": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "deleted_at": "<any>",
                  "metadata": "<any>"
                },
                "tags": [
                  "<any>"
                ],
                "length": 123,
                "title": "<string>",
                "status": "draft",
                "options": [
                  "<any>"
                ],
                "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": [
                  "<any>"
                ],
                "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
      },
      "claim": {
        "id": "<string>",
        "order_id": "<string>",
        "claim_items": [
          {
            "id": "<string>",
            "claim_id": "<string>",
            "order_id": "<string>",
            "item_id": "<string>",
            "quantity": 123,
            "reason": "missing_item",
            "raw_quantity": {
              "value": "<string>"
            },
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "additional_items": [
          {
            "id": "<string>",
            "claim_id": "<string>",
            "order_id": "<string>",
            "item_id": "<string>",
            "quantity": 123,
            "reason": "missing_item",
            "raw_quantity": {
              "value": "<string>"
            },
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "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>",
        "no_notification": true,
        "refund_amount": 123,
        "display_id": 123,
        "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": [
              "<any>"
            ],
            "adjustments": [
              "<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": {}
          }
        ],
        "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": {
          "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": [
                "<any>"
              ],
              "payment_sessions": [
                "<any>"
              ],
              "payments": [
                "<any>"
              ]
            }
          ],
          "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
            }
          ],
          "sales_channel": {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "is_disabled": true,
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          },
          "customer": {
            "id": "<string>",
            "has_account": true,
            "groups": [
              {}
            ],
            "email": "jsmith@example.com",
            "default_billing_address_id": "<string>",
            "default_shipping_address_id": "<string>",
            "company_name": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "addresses": [
              {}
            ],
            "phone": "<string>",
            "metadata": {},
            "created_by": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          },
          "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",
            "country": {
              "id": "<string>",
              "iso_2": "us",
              "iso_3": "usa",
              "num_code": 840,
              "name": "<string>",
              "display_name": "<string>"
            },
            "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",
            "country": {
              "id": "<string>",
              "iso_2": "us",
              "iso_3": "usa",
              "num_code": 840,
              "name": "<string>",
              "display_name": "<string>"
            },
            "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": {},
              "variant_id": "<string>",
              "product": {},
              "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": [
                "<any>"
              ],
              "adjustments": [
                "<any>"
              ],
              "detail": {},
              "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": [
                "<any>"
              ],
              "adjustments": [
                "<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": {}
            }
          ],
          "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>",
          "region": {
            "id": "<string>",
            "name": "<string>",
            "currency_code": "usd",
            "automatic_taxes": true,
            "countries": [
              {}
            ],
            "payment_providers": [
              {}
            ],
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "credit_lines": [
            {
              "id": "<string>",
              "order_id": "<string>",
              "order": {},
              "reference": "<string>",
              "reference_id": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "amount": 123
            }
          ],
          "credit_line_total": 123
        },
        "type": "replace",
        "order_version": "<string>",
        "created_by": "<string>",
        "canceled_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "actions": [
        {
          "id": "<string>",
          "order_change_id": "<string>",
          "order_change": {},
          "order_id": "<string>",
          "return_id": "<string>",
          "claim_id": "<string>",
          "exchange_id": "<string>",
          "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": [
                  "<any>"
                ],
                "payment_sessions": [
                  "<any>"
                ],
                "payments": [
                  "<any>"
                ]
              }
            ],
            "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
              }
            ],
            "sales_channel": {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "is_disabled": true,
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            },
            "customer": {
              "id": "<string>",
              "has_account": true,
              "groups": [
                {}
              ],
              "email": "jsmith@example.com",
              "default_billing_address_id": "<string>",
              "default_shipping_address_id": "<string>",
              "company_name": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "addresses": [
                {}
              ],
              "phone": "<string>",
              "metadata": {},
              "created_by": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            },
            "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",
              "country": {
                "id": "<string>",
                "iso_2": "us",
                "iso_3": "usa",
                "num_code": 840,
                "name": "<string>",
                "display_name": "<string>"
              },
              "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",
              "country": {
                "id": "<string>",
                "iso_2": "us",
                "iso_3": "usa",
                "num_code": 840,
                "name": "<string>",
                "display_name": "<string>"
              },
              "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": {},
                "variant_id": "<string>",
                "product": {},
                "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": [
                  "<any>"
                ],
                "adjustments": [
                  "<any>"
                ],
                "detail": {},
                "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": [
                  "<any>"
                ],
                "adjustments": [
                  "<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": {}
              }
            ],
            "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>",
            "region": {
              "id": "<string>",
              "name": "<string>",
              "currency_code": "usd",
              "automatic_taxes": true,
              "countries": [
                {}
              ],
              "payment_providers": [
                {}
              ],
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "credit_lines": [
              {
                "id": "<string>",
                "order_id": "<string>",
                "order": {},
                "reference": "<string>",
                "reference_id": "<string>",
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "amount": 123
              }
            ],
            "credit_line_total": 123
          },
          "reference": "claim",
          "reference_id": "<string>",
          "action": "CANCEL_RETURN_ITEM",
          "details": {
            "reference_id": 123,
            "quantity": 1
          },
          "internal_note": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "status": "canceled",
      "requested_by": "<string>",
      "requested_at": "2023-11-07T05:31:56Z",
      "confirmed_by": "<string>",
      "confirmed_at": "2023-11-07T05:31:56Z",
      "declined_by": "<string>",
      "declined_reason": "<string>",
      "metadata": {},
      "declined_at": "2023-11-07T05:31:56Z",
      "canceled_by": "<string>",
      "canceled_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "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": "<any>",
              "title": "<any>",
              "handle": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "deleted_at": "<any>",
              "products": "<any>",
              "metadata": "<any>"
            },
            "categories": [
              "<any>"
            ],
            "variants": [
              "<any>"
            ],
            "type": {
              "id": "<any>",
              "value": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "deleted_at": "<any>",
              "metadata": "<any>"
            },
            "tags": [
              "<any>"
            ],
            "length": 123,
            "title": "<string>",
            "status": "draft",
            "options": [
              "<any>"
            ],
            "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": [
              "<any>"
            ],
            "discountable": true,
            "external_id": "<string>",
            "deleted_at": "2023-11-07T05:31:56Z"
          },
          "product_id": "<string>",
          "calculated_price": {
            "id": "<any>",
            "is_calculated_price_price_list": "<any>",
            "is_calculated_price_tax_inclusive": "<any>",
            "calculated_amount": "<any>",
            "calculated_amount_with_tax": "<any>",
            "calculated_amount_without_tax": "<any>",
            "is_original_price_price_list": "<any>",
            "is_original_price_tax_inclusive": "<any>",
            "original_amount": "<any>",
            "currency_code": "<any>",
            "calculated_price": "<any>",
            "original_price": "<any>",
            "original_amount_with_tax": "<any>",
            "original_amount_without_tax": "<any>"
          },
          "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": "<any>",
          "categories": "<any>",
          "sales_channels": "<any>",
          "variants": "<any>",
          "type": "<any>",
          "tags": "<any>",
          "length": "<any>",
          "title": "<any>",
          "status": "<any>",
          "options": "<any>",
          "description": "<any>",
          "id": "<any>",
          "metadata": "<any>",
          "created_at": "<any>",
          "updated_at": "<any>",
          "handle": "<any>",
          "subtitle": "<any>",
          "is_giftcard": "<any>",
          "thumbnail": "<any>",
          "width": "<any>",
          "weight": "<any>",
          "height": "<any>",
          "origin_country": "<any>",
          "hs_code": "<any>",
          "mid_code": "<any>",
          "material": "<any>",
          "collection_id": "<any>",
          "type_id": "<any>",
          "images": "<any>",
          "discountable": "<any>",
          "external_id": "<any>",
          "deleted_at": "<any>",
          "shipping_profile": "<any>"
        },
        "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": {},
        "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,
        "actions": [
          {}
        ]
      }
    ],
    "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": "<string>",
        "original_subtotal": "<string>",
        "original_tax_total": "<string>",
        "total": "<string>",
        "subtotal": "<string>",
        "tax_total": "<string>",
        "discount_total": "<string>",
        "discount_tax_total": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "actions": [
          {}
        ]
      }
    ],
    "currency_code": "<string>",
    "version": 123,
    "id": "<string>",
    "region_id": "<string>",
    "customer_id": "<string>",
    "sales_channel_id": "<string>",
    "email": "jsmith@example.com",
    "display_id": 123,
    "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",
      "country": {
        "id": "<string>",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "<string>",
        "display_name": "<string>"
      },
      "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",
      "country": {
        "id": "<string>",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "<string>",
        "display_name": "<string>"
      },
      "province": "us-ca",
      "postal_code": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "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": [
          "<any>"
        ],
        "payment_sessions": [
          "<any>"
        ],
        "payments": [
          "<any>"
        ]
      }
    ],
    "payment_status": "canceled",
    "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
      }
    ],
    "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,
    "customer": {
      "id": "<string>",
      "has_account": true,
      "groups": [
        {}
      ],
      "email": "jsmith@example.com",
      "default_billing_address_id": "<string>",
      "default_shipping_address_id": "<string>",
      "company_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "addresses": [
        {}
      ],
      "phone": "<string>",
      "metadata": {},
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "sales_channel": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "is_disabled": true,
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "status": "<string>",
    "region": {
      "id": "<string>",
      "name": "<string>",
      "currency_code": "usd",
      "automatic_taxes": true,
      "countries": [
        {}
      ],
      "payment_providers": [
        {}
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "credit_lines": [
      {
        "id": "<string>",
        "order_id": "<string>",
        "order": {},
        "reference": "<string>",
        "reference_id": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "amount": 123
      }
    ],
    "credit_line_total": 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>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The return's ID.

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.

Body

application/json

The shipping method's details.

​
shipping_option_id
string
required

The ID of the associated shipping option.

​
custom_amount
number

Set the price of the shipping method.

​
description
string

The shipping method's description.

​
internal_note
string

A note viewed only by admin users.

​
metadata
object

The exchange's metadata, can hold custom key-value pairs.

Response

OK

The details of a return and a preview of the order once the return is applied.

​
order_preview
object
required

A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.

​
return
object
required

The return's details.