--- displayed_sidebar: entitiesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # GiftCardTransaction ## Properties [`GiftCard`](GiftCard.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "balance", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "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": "ends_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "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": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "automatic_taxes", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "countries", "type": "[`Country`](Country.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": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "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": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](TaxProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](TaxRate.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": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "value", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "gift_card_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_taxable", "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": "constructor", "type": "() => [`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "address_1", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](Country.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "province", "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": "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": "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": "claims", "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": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "currency", "type": "[`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Currency`](Currency.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "symbol_native", "type": "`string`", "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": "constructor", "type": "() => [`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "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": "email", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "first_name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "last_name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "orders", "type": "[`Order`](Order.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "password_hash", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "phone", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](Address.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": "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": "constructor", "type": "() => [`Discount`](Discount.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "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": "ends_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "parent_discount", "type": "[`Discount`](Discount.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "regions", "type": "[`Region`](Region.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "rule", "type": "[`DiscountRule`](DiscountRule.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "rule_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "usage_count", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "upperCaseCodeAndTrim", "type": "() => `void`", "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": "constructor", "type": "() => [`DraftOrder`](DraftOrder.mdx)", "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": "completed_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "display_id", "type": "`number`", "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_order", "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": "status", "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", "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": "draft_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "edits", "type": "[`OrderEdit`](OrderEdit.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`OrderEdit`](OrderEdit.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_by", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "declined_by", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "difference_due", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "`number`", "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": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "internal_note", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "items", "type": "[`LineItem`](LineItem.mdx)[]", "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_collection", "type": "[`PaymentCollection`](PaymentCollection.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "requested_by", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "`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": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "loadStatus", "type": "() => `void`", "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": "CANCELED", "type": "``\"canceled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](Fulfillment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Fulfillment`](Fulfillment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order_id", "type": "`string`", "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": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "location_id", "type": "``null`` \\| `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": "provider", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "provider_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](TrackingLink.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tracking_numbers", "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": "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": "constructor", "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](GiftCard.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_taxable", "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": "tax_rate", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](GiftCard.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`GiftCard`](GiftCard.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "balance", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "code", "type": "`string`", "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": "ends_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "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": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "value", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "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": "constructor", "type": "() => [`LineItem`](LineItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "adjustments", "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "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": "claim_order", "type": "[`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "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_giftcard", "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": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "unit_price", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant", "type": "[`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterUpdateOrLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeUpdate", "type": "() => `void`", "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": "AWAITING", "type": "``\"awaiting\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "payments", "type": "[`Payment`](Payment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Payment`](Payment.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "captured_at", "type": "`string` \\| `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": "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": "data", "type": "Record<`string`, `unknown`\\>", "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": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "provider_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap_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": "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": "constructor", "type": "() => [`Refund`](Refund.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "amount", "type": "`number`", "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": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "note", "type": "`string`", "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_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "reason", "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": "region", "type": "[`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Region`](Region.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "automatic_taxes", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "countries", "type": "[`Country`](Country.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": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "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": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_code", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](TaxProvider.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](TaxRate.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": "region_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": true, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`LineItem`](LineItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "adjustments", "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "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": "claim_order", "type": "[`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "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_giftcard", "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": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "unit_price", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant", "type": "[`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterUpdateOrLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeUpdate", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "returns", "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": "sales_channel", "type": "[`SalesChannel`](SalesChannel.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`SalesChannel`](SalesChannel.mdx)", "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": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "name", "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": "sales_channel_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "address_1", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](Country.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](Customer.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "province", "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_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "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": "cart_id", "type": "`string`", "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": "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": "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": "shipping_option", "type": "[`ShippingOption`](ShippingOption.mdx)", "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": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", "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_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": "ARCHIVED", "type": "``\"archived\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swaps", "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": "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": "tax_rate", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] } ]} />