---
displayed_sidebar: entitiesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# ShippingMethodTaxLine

## Properties

<ParameterTypes parameters={[
  {
    "name": "code",
    "type": "``null`` \\| `string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "created_at",
    "type": "`Date`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "metadata",
    "type": "Record<`string`, `unknown`\\>",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "name",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "rate",
    "type": "`number`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "shipping_method",
    "type": "[`ShippingMethod`](ShippingMethod.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": [
      {
        "name": "constructor",
        "type": "() => [`ShippingMethod`](ShippingMethod.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "cart",
        "type": "[`Cart`](Cart.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`Cart`](Cart.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "billing_address",
            "type": "[`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "billing_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "completed_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "context",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "customer",
            "type": "[`Customer`](Customer.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "customer_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "``null`` \\| `Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "discount_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "discounts",
            "type": "[`Discount`](Discount.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "email",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_card_tax_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_card_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_cards",
            "type": "[`GiftCard`](GiftCard.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "item_tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "items",
            "type": "[`LineItem`](LineItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "object",
            "type": "``\"cart\"``",
            "description": "",
            "optional": false,
            "defaultValue": "`\"cart\"`",
            "children": []
          },
          {
            "name": "payment",
            "type": "[`Payment`](Payment.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_authorized_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_session",
            "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_sessions",
            "type": "[`PaymentSession`](PaymentSession.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "raw_discount_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refundable_amount",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refunded_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region",
            "type": "[`Region`](Region.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "sales_channel",
            "type": "[`SalesChannel`](SalesChannel.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "sales_channel_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "``null`` \\| [`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "subtotal",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "total",
            "type": "`number`",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "type",
            "type": "[`CartType`](../enums/CartType.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "afterLoad",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "cart_id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "claim_order",
        "type": "[`ClaimOrder`](ClaimOrder.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`ClaimOrder`](ClaimOrder.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "additional_items",
            "type": "[`LineItem`](LineItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "claim_items",
            "type": "[`ClaimItem`](ClaimItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillments",
            "type": "[`Fulfillment`](Fulfillment.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order",
            "type": "[`Order`](Order.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refund_amount",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "return_order",
            "type": "[`Return`](Return.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "type",
            "type": "[`ClaimType`](../enums/ClaimType.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "claim_order_id",
        "type": "``null`` \\| `string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "data",
        "type": "Record<`string`, `unknown`\\>",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "includes_tax",
        "type": "`boolean`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "order",
        "type": "[`Order`](Order.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`Order`](Order.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "billing_address",
            "type": "[`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "billing_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "cart",
            "type": "[`Cart`](Cart.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "cart_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "claims",
            "type": "[`ClaimOrder`](ClaimOrder.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "currency",
            "type": "[`Currency`](Currency.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "currency_code",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "customer",
            "type": "[`Customer`](Customer.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "customer_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "discount_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "discounts",
            "type": "[`Discount`](Discount.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "display_id",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "draft_order",
            "type": "[`DraftOrder`](DraftOrder.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "draft_order_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "edits",
            "type": "[`OrderEdit`](OrderEdit.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "email",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "external_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillments",
            "type": "[`Fulfillment`](Fulfillment.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_card_tax_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_card_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_card_transactions",
            "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "gift_cards",
            "type": "[`GiftCard`](GiftCard.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "item_tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "items",
            "type": "[`LineItem`](LineItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "object",
            "type": "``\"order\"``",
            "description": "",
            "optional": false,
            "defaultValue": "`\"order\"`",
            "children": []
          },
          {
            "name": "paid_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payments",
            "type": "[`Payment`](Payment.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "raw_discount_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refundable_amount",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refunded_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refunds",
            "type": "[`Refund`](Refund.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region",
            "type": "[`Region`](Region.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "returnable_items",
            "type": "[`LineItem`](LineItem.mdx)[]",
            "description": "",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "returns",
            "type": "[`Return`](Return.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "sales_channel",
            "type": "[`SalesChannel`](SalesChannel.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "sales_channel_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "status",
            "type": "[`OrderStatus`](../enums/OrderStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "subtotal",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "swaps",
            "type": "[`Swap`](Swap.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "tax_rate",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "tax_total",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "total",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `Promise`<`void`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "order_id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "return_id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "return_order",
        "type": "[`Return`](Return.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`Return`](Return.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "claim_order",
            "type": "[`ClaimOrder`](ClaimOrder.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "claim_order_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "items",
            "type": "[`ReturnItem`](ReturnItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "location_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "``null`` \\| Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "no_notification",
            "type": "``null`` \\| `boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order",
            "type": "[`Order`](Order.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "received_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "refund_amount",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_data",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_method",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "status",
            "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "swap",
            "type": "[`Swap`](Swap.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "swap_id",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "shipping_option",
        "type": "[`ShippingOption`](ShippingOption.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`ShippingOption`](ShippingOption.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "admin_only",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "amount",
            "type": "``null`` \\| `number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "data",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "``null`` \\| `Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "includes_tax",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "is_return",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "price_type",
            "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "profile",
            "type": "[`ShippingProfile`](ShippingProfile.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "profile_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "provider",
            "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "provider_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region",
            "type": "[`Region`](Region.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "requirements",
            "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "shipping_option_id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "subtotal",
        "type": "`number`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "swap",
        "type": "[`Swap`](Swap.mdx)",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`Swap`](Swap.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "additional_items",
            "type": "[`LineItem`](LineItem.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "allow_backorder",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "cart",
            "type": "[`Cart`](Cart.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "cart_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "confirmed_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "deleted_at",
            "type": "``null`` \\| `Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "difference_due",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "fulfillments",
            "type": "[`Fulfillment`](Fulfillment.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order",
            "type": "[`Order`](Order.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "order_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment",
            "type": "[`Payment`](Payment.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "return_order",
            "type": "[`Return`](Return.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[`Address`](Address.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)[]",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "swap_id",
        "type": "`string`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "tax_lines",
        "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": [
          {
            "name": "constructor",
            "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "code",
            "type": "``null`` \\| `string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "metadata",
            "type": "Record<`string`, `unknown`\\>",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "rate",
            "type": "`number`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_method",
            "type": "[`ShippingMethod`](ShippingMethod.mdx)",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "shipping_method_id",
            "type": "`string`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "beforeInsert",
            "type": "() => `void`",
            "description": "",
            "optional": false,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "tax_total",
        "type": "`number`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "total",
        "type": "`number`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "beforeInsert",
        "type": "() => `void`",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "children": []
      }
    ]
  },
  {
    "name": "shipping_method_id",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "updated_at",
    "type": "`Date`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "children": []
  }
]} />
