@medusajs/types 1.12.0-snapshot-20240802122417 → 1.12.0-snapshot-20240807192059

package/dist/order/common.d.ts

@@ -4,24 +4,80 @@ import { FulfillmentDTO } from "../fulfillment";
 import { PaymentCollectionDTO } from "../payment";
 import { BigNumberInput, BigNumberRawValue, BigNumberValue } from "../totals";
 import { ClaimReason } from "./mutations";
+/**
+ * The change action's type.
+ */
 export type ChangeActionType = "CANCEL" | "CANCEL_RETURN_ITEM" | "FULFILL_ITEM" | "CANCEL_ITEM_FULFILLMENT" | "ITEM_ADD" | "ITEM_REMOVE" | "RECEIVE_DAMAGED_RETURN_ITEM" | "RECEIVE_RETURN_ITEM" | "RETURN_ITEM" | "SHIPPING_ADD" | "SHIPPING_REMOVE" | "SHIP_ITEM" | "WRITE_OFF_ITEM" | "REINSTATE_ITEM";
+/**
+ * @interface
+ *
+ * The order summary details.
+ */
 export type OrderSummaryDTO = {
+    /**
+     * The total of the order summary.
+     */
     total: BigNumberValue;
+    /**
+     * The subtotal of the order summary.
+     */
     subtotal: BigNumberValue;
+    /**
+     * The total tax of the order summary.
+     */
     total_tax: BigNumberValue;
+    /**
+     * The ordered total of the order summary.
+     */
     ordered_total: BigNumberValue;
+    /**
+     * The fulfilled total of the order summary.
+     */
     fulfilled_total: BigNumberValue;
+    /**
+     * The returned total of the order summary.
+     */
     returned_total: BigNumberValue;
+    /**
+     * The return request total of the order summary.
+     */
     return_request_total: BigNumberValue;
+    /**
+     * The write off total of the order summary.
+     */
     write_off_total: BigNumberValue;
+    /**
+     * The projected total of the order summary.
+     */
     projected_total: BigNumberValue;
+    /**
+     * The net total of the order summary.
+     */
     net_total: BigNumberValue;
+    /**
+     * The net subtotal of the order summary.
+     */
     net_subtotal: BigNumberValue;
+    /**
+     * The net total tax of the order summary.
+     */
     net_total_tax: BigNumberValue;
+    /**
+     * The balance of the order summary.
+     */
     balance: BigNumberValue;
+    /**
+     * The paid total of the order summary.
+     */
     paid_total: BigNumberValue;
+    /**
+     * The refunded total of the order summary.
+     */
     refunded_total: BigNumberValue;
 };
+/**
+ * The adjustment line details.
+ */
 export interface OrderAdjustmentLineDTO {
     /**
      * The ID of the adjustment line
@@ -60,68 +116,85 @@ export interface OrderAdjustmentLineDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The shipping method adjustment details.
+ */
 export interface OrderShippingMethodAdjustmentDTO extends OrderAdjustmentLineDTO {
     /**
-     * The associated shipping method
+     * The associated shipping method.
+     *
+     * @expandable
      */
     shipping_method: OrderShippingMethodDTO;
     /**
-     * The ID of the associated shipping method
+     * The ID of the associated shipping method.
      */
     shipping_method_id: string;
 }
+/**
+ * The line item adjustment details.
+ */
 export interface OrderLineItemAdjustmentDTO extends OrderAdjustmentLineDTO {
     /**
-     * The associated line item
+     * The associated line item.
+     *
      * @expandable
      */
     item: OrderLineItemDTO;
     /**
-     * The associated line item
+     * The ID of the associated line item.
      */
     item_id: string;
 }
+/**
+ * The tax line details.
+ */
 export interface OrderTaxLineDTO {
     /**
-     * The ID of the tax line
+     * The ID of the tax line.
      */
     id: string;
     /**
-     * The description of the tax line
+     * The description of the tax line.
      */
     description?: string;
     /**
-     * The ID of the associated tax rate
+     * The ID of the associated tax rate.
      */
     tax_rate_id?: string;
     /**
-     * The code of the tax line
+     * The code of the tax line.
      */
     code: string;
     /**
-     * The rate of the tax line
+     * The rate of the tax line.
      */
     rate: number;
     /**
-     * The ID of the associated provider
+     * The ID of the associated provider.
      */
     provider_id?: string;
     /**
-     * When the tax line was created
+     * When the tax line was created.
      */
     created_at: Date | string;
     /**
-     * When the tax line was updated
+     * When the tax line was updated.
      */
     updated_at: Date | string;
 }
+/**
+ * The shipping method tax line details.
+ */
 export interface OrderShippingMethodTaxLineDTO extends OrderTaxLineDTO {
     /**
-     * The associated shipping method
+     * The associated shipping method.
+     *
+     * @expandable
      */
     shipping_method: OrderShippingMethodDTO;
     /**
-     * The ID of the associated shipping method
+     * The ID of the associated shipping method.
      */
     shipping_method_id: string;
     /**
@@ -141,13 +214,18 @@ export interface OrderShippingMethodTaxLineDTO extends OrderTaxLineDTO {
      */
     raw_subtotal: BigNumberRawValue;
 }
+/**
+ * The line item tax line details.
+ */
 export interface OrderLineItemTaxLineDTO extends OrderTaxLineDTO {
     /**
-     * The associated line item
+     * The associated line item.
+     *
+     * @expandable
      */
     item: OrderLineItemDTO;
     /**
-     * The ID of the associated line item
+     * The ID of the associated line item.
      */
     item_id: string;
     /**
@@ -167,53 +245,56 @@ export interface OrderLineItemTaxLineDTO extends OrderTaxLineDTO {
      */
     raw_subtotal: BigNumberRawValue;
 }
+/**
+ * The address details.
+ */
 export interface OrderAddressDTO {
     /**
-     * The ID of the address
+     * The ID of the address.
      */
     id: string;
     /**
-     * The customer ID of the address
+     * The customer ID of the address.
      */
     customer_id?: string;
     /**
-     * The first name of the address
+     * The first name of the address.
      */
     first_name?: string;
     /**
-     * The last name of the address
+     * The last name of the address.
      */
     last_name?: string;
     /**
-     * The phone number of the address
+     * The phone number of the address.
      */
     phone?: string;
     /**
-     * The company of the address
+     * The company of the address.
      */
     company?: string;
     /**
-     * The first address line of the address
+     * The first address line of the address.
      */
     address_1?: string;
     /**
-     * The second address line of the address
+     * The second address line of the address.
      */
     address_2?: string;
     /**
-     * The city of the address
+     * The city of the address.
      */
     city?: string;
     /**
-     * The country code of the address
+     * The country code of the address.
      */
     country_code?: string;
     /**
-     * The province/state of the address
+     * The province/state of the address.
      */
     province?: string;
     /**
-     * The postal code of the address
+     * The postal code of the address.
      */
     postal_code?: string;
     /**
@@ -229,37 +310,40 @@ export interface OrderAddressDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The order shipping method details.
+ */
 export interface OrderShippingMethodDTO {
     /**
-     * The ID of the shipping method
+     * The ID of the shipping method.
      */
     id: string;
     /**
-     * The ID of the associated order
+     * The ID of the associated order.
      */
     order_id: string;
     /**
-     * The name of the shipping method
+     * The name of the shipping method.
      */
     name: string;
     /**
-     * The description of the shipping method
+     * The description of the shipping method.
      */
     description?: string;
     /**
-     * The price of the shipping method
+     * The price of the shipping method.
      */
     amount: BigNumberValue;
     /**
-     * The raw price of the shipping method
+     * The raw price of the shipping method.
      */
     raw_amount: BigNumberRawValue;
     /**
-     * Whether the shipping method price is tax inclusive or not
+     * Whether the shipping method price is tax inclusive or not.
      */
     is_tax_inclusive: boolean;
     /**
-     * The ID of the shipping option the method was created from
+     * The ID of the shipping option the method was created from.
      */
     shipping_option_id?: string;
     /**
@@ -355,6 +439,9 @@ export interface OrderShippingMethodDTO {
      */
     raw_discount_tax_total: BigNumberRawValue;
 }
+/**
+ * The order line item totals details.
+ */
 export interface OrderLineItemTotalsDTO {
     /**
      * The original total of the order line item.
@@ -461,105 +548,108 @@ export interface OrderLineItemTotalsDTO {
      */
     raw_refundable_total_per_unit: BigNumberRawValue;
 }
+/**
+ * The line item details.
+ */
 export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
     /**
-     * The ID of the order line item.
+     * The ID of the line item.
      */
     id: string;
     /**
-     * The title of the order line item.
+     * The title of the line item.
      */
     title: string;
     /**
-     * The subtitle of the order line item.
+     * The subtitle of the line item.
      */
     subtitle?: string | null;
     /**
-     * The thumbnail of the order line item.
+     * The thumbnail of the line item.
      */
     thumbnail?: string | null;
     /**
-     * The ID of the variant associated with the order line item.
+     * The ID of the variant associated with the line item.
      */
     variant_id?: string | null;
     /**
-     * The ID of the product associated with the order line item.
+     * The ID of the product associated with the line item.
      */
     product_id?: string | null;
     /**
-     * The title of the product associated with the order line item.
+     * The title of the product associated with the line item.
      */
     product_title?: string | null;
     /**
-     * The description of the product associated with the order line item.
+     * The description of the product associated with the line item.
      */
     product_description?: string | null;
     /**
-     * The subtitle of the product associated with the order line item.
+     * The subtitle of the product associated with the line item.
      */
     product_subtitle?: string | null;
     /**
-     * The type of the product associated with the order line item.
+     * The type of the product associated with the line item.
      */
     product_type?: string | null;
     /**
-     * The collection of the product associated with the order line item.
+     * The collection of the product associated with the line item.
      */
     product_collection?: string | null;
     /**
-     * The handle of the product associated with the order line item.
+     * The handle of the product associated with the line item.
      */
     product_handle?: string | null;
     /**
-     * The SKU (stock keeping unit) of the variant associated with the order line item.
+     * The SKU (stock keeping unit) of the variant associated with the line item.
      */
     variant_sku?: string | null;
     /**
-     * The barcode of the variant associated with the order line item.
+     * The barcode of the variant associated with the line item.
      */
     variant_barcode?: string | null;
     /**
-     * The title of the variant associated with the order line item.
+     * The title of the variant associated with the line item.
      */
     variant_title?: string | null;
     /**
-     * The option values of the variant associated with the order line item.
+     * The option values of the variant associated with the line item.
      */
     variant_option_values?: Record<string, unknown> | null;
     /**
-     * Indicates whether the order line item requires shipping.
+     * Indicates whether the line item requires shipping.
      */
     requires_shipping: boolean;
     /**
-     * Indicates whether the order line item is discountable.
+     * Indicates whether the line item is discountable.
      */
     is_discountable: boolean;
     /**
-     * Indicates whether the order line item price is tax inclusive.
+     * Indicates whether the line item price is tax inclusive.
      */
     is_tax_inclusive: boolean;
     /**
-     * The compare at unit price of the order line item.
+     * The compare at unit price of the line item.
      */
     compare_at_unit_price?: number;
     /**
-     * The raw compare at unit price of the order line item.
+     * The raw compare at unit price of the line item.
      */
     raw_compare_at_unit_price?: BigNumberRawValue;
     /**
-     * The unit price of the order line item.
+     * The unit price of the line item.
      */
     unit_price: number;
     /**
-     * The raw unit price of the order line item.
+     * The raw unit price of the line item.
      */
     raw_unit_price: BigNumberRawValue;
     /**
-     * The quantity of the order line item.
+     * The quantity of the line item.
      */
     quantity: number;
     /**
-     * The raw quantity of the order line item.
+     * The raw quantity of the line item.
      */
     raw_quantity: BigNumberRawValue;
     /**
@@ -579,11 +669,11 @@ export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
      */
     detail: OrderItemDTO;
     /**
-     * The date when the order line item was created.
+     * The date when the line item was created.
      */
     created_at: Date;
     /**
-     * The date when the order line item was last updated.
+     * The date when the line item was last updated.
      */
     updated_at: Date;
     /**
@@ -591,9 +681,12 @@ export interface OrderLineItemDTO extends OrderLineItemTotalsDTO {
      */
     metadata?: Record<string, unknown> | null;
 }
+/**
+ * The order item details.
+ */
 export interface OrderItemDTO {
     /**
-     * The ID of the order detail.
+     * The ID of the order item.
      */
     id: string;
     /**
@@ -601,7 +694,9 @@ export interface OrderItemDTO {
      */
     item_id: string;
     /**
-     * The Line Item of the order detail.
+     * The associated line item.
+     *
+     * @expandable
      */
     item: OrderLineItemDTO;
     /**
@@ -673,7 +768,13 @@ export interface OrderItemDTO {
      */
     updated_at: Date;
 }
+/**
+ * The order's status.
+ */
 type OrderStatus = "pending" | "completed" | "draft" | "archived" | "canceled" | "requires_action";
+/**
+ * The order details.
+ */
 export interface OrderDTO {
     /**
      * The ID of the order.
@@ -685,6 +786,8 @@ export interface OrderDTO {
     version: number;
     /**
      * The active order change, if any.
+     *
+     * @expandable
      */
     order_change?: OrderChangeDTO;
     /**
@@ -743,6 +846,8 @@ export interface OrderDTO {
     transactions?: OrderTransactionDTO[];
     /**
      * The summary of the order totals.
+     *
+     * @expandable
      */
     summary?: OrderSummaryDTO;
     /**
@@ -938,85 +1043,313 @@ export interface OrderDTO {
      */
     raw_original_shipping_tax_total: BigNumberRawValue;
 }
+/**
+ * The return's status.
+ */
 type ReturnStatus = "requested" | "received" | "partially_received" | "canceled";
+/**
+ * The return details.
+ */
 export interface ReturnDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+    /**
+     * The ID of the return.
+     */
     id: string;
+    /**
+     * The status of the return.
+     */
     status: ReturnStatus;
+    /**
+     * The refund amount of the return.
+     */
     refund_amount?: BigNumberValue;
+    /**
+     * The associated order's ID.
+     */
     order_id: string;
+    /**
+     * The items of the return
+     */
     items: OrderReturnItemDTO[];
 }
+/**
+ * The order return item details.
+ */
 export interface OrderReturnItemDTO {
+    /**
+     * The ID of the order return item.
+     */
     id: string;
+    /**
+     * The associated return's ID.
+     */
     return_id: string;
+    /**
+     * The associated order's ID.
+     */
     order_id: string;
+    /**
+     * The associated line item's ID.
+     */
     item_id: string;
+    /**
+     * The associated reason's ID.
+     */
     reason_id?: string | null;
+    /**
+     * The quantity of the item to return.
+     */
     quantity: number;
+    /**
+     * The raw quantity of the item to return.
+     */
     raw_quantity: BigNumberRawValue;
+    /**
+     * The received quantity of the return item.
+     */
     received_quantity?: number;
+    /**
+     * The raw received quantity of the return item.
+     */
     raw_received_quantity?: BigNumberRawValue;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the return item.
+     */
     created_at?: Date | string;
+    /**
+     * The update date of the return item.
+     */
     updated_at?: Date | string;
 }
+/**
+ * The order claim item details.
+ */
 export interface OrderClaimItemDTO {
+    /**
+     * The ID of the order claim item.
+     */
     id: string;
+    /**
+     * The associated claim's ID.
+     */
     claim_id: string;
+    /**
+     * The associated order's ID.
+     */
     order_id: string;
+    /**
+     * The associated item's ID.
+     */
     item_id: string;
+    /**
+     * The quantity of the order claim item
+     */
     quantity: number;
+    /**
+     * The reason of the order claim item
+     */
     reason: ClaimReason;
+    /**
+     * The raw quantity of the order claim item
+     */
     raw_quantity: BigNumberRawValue;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the order claim item
+     */
     created_at?: Date | string;
+    /**
+     * The update date of the order claim item
+     */
     updated_at?: Date | string;
 }
+/**
+ * The order claim item image details.
+ */
 export interface OrderClaimItemImageDTO {
+    /**
+     * The ID of the order claim item image.
+     */
     id: string;
+    /**
+     * The associated claim item's ID.
+     */
     claim_item_id: string;
+    /**
+     * The url of the order claim item image
+     */
     url: string;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the order claim item image
+     */
     created_at?: Date | string;
+    /**
+     * The update date of the order claim item image
+     */
     updated_at?: Date | string;
 }
+/**
+ * The order exchange item details.
+ */
 export interface OrderExchangeItemDTO {
+    /**
+     * The ID of the order exchange item.
+     */
     id: string;
+    /**
+     * The associated exchange's ID.
+     */
     exchange_id: string;
+    /**
+     * The associated order's ID.
+     */
     order_id: string;
+    /**
+     * The associated item's ID.
+     */
     item_id: string;
+    /**
+     * The quantity of the order exchange item
+     */
     quantity: number;
+    /**
+     * The raw quantity of the order exchange item
+     */
     raw_quantity: BigNumberRawValue;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown> | null;
+    /**
+     * The creation date of the order exchange item
+     */
     created_at?: Date | string;
+    /**
+     * The update date of the order exchange item
+     */
     updated_at?: Date | string;
 }
+/**
+ * The claim details.
+ */
 export interface OrderClaimDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+    /**
+     * The ID of the associated order.
+     */
     order_id: string;
+    /**
+     * The items to be received from the customer
+     * if the claim's type is `replace`.
+     */
     claim_items: any[];
+    /**
+     * The items to be sent to the customer
+     * if the claim's type is `replace`.
+     */
     additional_items: any[];
+    /**
+     * The associated return, if the claim's type is `replace`.
+     */
     return?: ReturnDTO;
+    /**
+     * The ID of the associated return, if the claim's type is `replace`.
+     */
     return_id?: string;
+    /**
+     * Whether the customer should receive notifications related
+     * to updates on the claim.
+     */
     no_notification?: boolean;
+    /**
+     * The refund amount of the claim.
+     */
     refund_amount?: BigNumberValue;
 }
+/**
+ * The exchange details.
+ */
 export interface OrderExchangeDTO extends Omit<OrderDTO, "status" | "version" | "items"> {
+    /**
+     * The associated order's ID.
+     */
     order_id: string;
+    /**
+     * The items to be returned from the customer.
+     */
     return_items: any[];
+    /**
+     * The items to be sent to the customer.
+     */
     additional_items: any[];
+    /**
+     * Whether the customer should receive notifications related
+     * to updates on the exchange.
+     */
     no_notification?: boolean;
+    /**
+     * The difference due of the order exchange.
+     *
+     * - If less than `0`, the merchant owes the customer this amount.
+     * - If greater than `0`, the customer owes the merchange this amount.
+     * - If equal to `0`, no payment is required by either sides.
+     */
     difference_due?: BigNumberValue;
+    /**
+     * The associated return.
+     */
     return?: ReturnDTO;
+    /**
+     * The associated return's ID.
+     */
     return_id?: string;
 }
+/**
+ * The payment's status.
+ */
 export type PaymentStatus = "not_paid" | "awaiting" | "authorized" | "partially_authorized" | "captured" | "partially_captured" | "partially_refunded" | "refunded" | "canceled" | "requires_action";
+/**
+ * The fulfillment's status.
+ */
 export type FulfillmentStatus = "not_fulfilled" | "partially_fulfilled" | "fulfilled" | "partially_shipped" | "shipped" | "partially_delivered" | "delivered" | "canceled";
+/**
+ * The data of the order details.
+ */
 export interface OrderDetailDTO extends OrderDTO {
+    /**
+     * The associated payment collections.
+     *
+     * @expandable
+     */
     payment_collections: PaymentCollectionDTO[];
+    /**
+     * The payment status of the order detail.
+     */
     payment_status: PaymentStatus;
+    /**
+     * The associated fulfillments.
+     *
+     * @expandable
+     */
     fulfillments: FulfillmentDTO[];
+    /**
+     * The fulfillment status of the order detail.
+     */
     fulfillment_status: FulfillmentStatus;
 }
+/**
+ * The order change details.
+ */
 export interface OrderChangeDTO {
     /**
      * The ID of the order change
@@ -1129,6 +1462,9 @@ export interface OrderChangeDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The order change action details.
+ */
 export interface OrderChangeActionDTO {
     /**
      * The ID of the order change action
@@ -1148,8 +1484,17 @@ export interface OrderChangeActionDTO {
      * The ID of the associated order
      */
     order_id: string | null;
+    /**
+     * The ID of the associated return.
+     */
     return_id: string | null;
+    /**
+     * The ID of the associated claim.
+     */
     claim_id: string | null;
+    /**
+     * The ID of the associated exchange.
+     */
     exchange_id: string | null;
     /**
      * The associated order
@@ -1186,6 +1531,9 @@ export interface OrderChangeActionDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The order transaction details.
+ */
 export interface OrderTransactionDTO {
     /**
      * The ID of the transaction
@@ -1230,6 +1578,9 @@ export interface OrderTransactionDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The order transaction details.
+ */
 export interface OrderTransactionDTO {
     /**
      * The ID of the transaction
@@ -1278,6 +1629,9 @@ export interface OrderTransactionDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The order return reason details.
+ */
 export interface OrderReturnReasonDTO {
     /**
      * The ID of the return reason
@@ -1299,7 +1653,13 @@ export interface OrderReturnReasonDTO {
      * The parent return reason ID
      */
     parent_return_reason_id?: string;
+    /**
+     * The associated order return reason.
+     */
     parent_return_reason?: OrderReturnReasonDTO;
+    /**
+     * The return reason children of the order return reason.
+     */
     return_reason_children?: OrderReturnReasonDTO[];
     /**
      * The metadata of the return reason
@@ -1314,132 +1674,462 @@ export interface OrderReturnReasonDTO {
      */
     updated_at: Date | string;
 }
+/**
+ * The filters to apply on the retrieved orders.
+ */
 export interface FilterableOrderProps extends BaseFilterable<FilterableOrderProps> {
+    /**
+     * The IDs to filter the orders by.
+     */
     id?: string | string[];
+    /**
+     * Filter orders by their associated sales channel's ID.
+     */
     sales_channel_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter orders by their associated customer's ID.
+     */
     customer_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter orders by their associated region's ID.
+     */
     region_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the orders by their creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter orders by their update date.
+     */
     updated_at?: OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved order addresss.
+ */
 export interface FilterableOrderAddressProps extends BaseFilterable<FilterableOrderAddressProps> {
+    /**
+     * The IDs to filter the order addresss by.
+     */
     id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved order line items.
+ */
 export interface FilterableOrderLineItemProps extends BaseFilterable<FilterableOrderLineItemProps> {
+    /**
+     * The IDs to filter the order line items by.
+     */
     id?: string | string[];
+    /**
+     * Filter line items by their associated order's ID.
+     */
     order_id?: string | string[];
+    /**
+     * Filter by line items' title.
+     */
     title?: string;
+    /**
+     * Filter line items by their associated variant's ID.
+     */
     variant_id?: string | string[];
+    /**
+     * Filter line items by their associated product's ID.
+     */
     product_id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved line item adjustments.
+ */
 export interface FilterableOrderLineItemAdjustmentProps extends BaseFilterable<FilterableOrderLineItemAdjustmentProps> {
+    /**
+     * The IDs to filter the line item adjustments by.
+     */
     id?: string | string[];
+    /**
+     * Filter adjustments by their associated item's ID.
+     */
     item_id?: string | string[];
+    /**
+     * Filter adjustments by their associated promotion's ID.
+     */
     promotion_id?: string | string[];
+    /**
+     * Filter adjustments by their associated provider's ID.
+     */
     provider_id?: string | string[];
+    /**
+     * The filters to apply on the associated line items.
+     */
     item?: FilterableOrderLineItemProps;
 }
+/**
+ * The filters to apply on the retrieved shipping methods.
+ */
 export interface FilterableOrderShippingMethodProps extends BaseFilterable<FilterableOrderShippingMethodProps> {
+    /**
+     * The IDs to filter the shipping methods by.
+     */
     id?: string | string[];
+    /**
+     * Filter the shipping methods by their associated order's ID.
+     */
     order_id?: string | string[];
+    /**
+     * Filter shipping methods by their name.
+     */
     name?: string;
+    /**
+     * Filter the shipping methods by their associated shipping option's ID.
+     */
     shipping_option_id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved shipping method adjustments.
+ */
 export interface FilterableOrderShippingMethodAdjustmentProps extends BaseFilterable<FilterableOrderShippingMethodAdjustmentProps> {
+    /**
+     * The IDs to filter the shipping method adjustments by.
+     */
     id?: string | string[];
+    /**
+     * Filter the adjustments by their associated shipping method's ID.
+     */
     shipping_method_id?: string | string[];
+    /**
+     * Filter the adjustments by their associated promotion's ID.
+     */
     promotion_id?: string | string[];
+    /**
+     * Filter the adjustments by their associated provider's ID.
+     */
     provider_id?: string | string[];
+    /**
+     * The filters to apply on the associated shipping methods.
+     */
     shipping_method?: FilterableOrderShippingMethodProps;
 }
+/**
+ * The filters to apply on the retrieved line item tax lines.
+ */
 export interface FilterableOrderLineItemTaxLineProps extends BaseFilterable<FilterableOrderLineItemTaxLineProps> {
+    /**
+     * The IDs to filter the line item tax lines by.
+     */
     id?: string | string[];
+    /**
+     * Filter line item tax lines by their description.
+     */
     description?: string;
+    /**
+     * Filter line item tax lines by their code.
+     */
     code?: string | string[];
+    /**
+     * Filter the tax lines by their associated tax rate's ID.
+     */
     tax_rate_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated provider's ID.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated item's ID.
+     */
     item_id?: string | string[];
+    /**
+     * The filters to apply on the associated line items.
+     */
     item?: FilterableOrderLineItemProps;
 }
+/**
+ * The filters to apply on the retrieved shipping method tax lines.
+ */
 export interface FilterableOrderShippingMethodTaxLineProps extends BaseFilterable<FilterableOrderShippingMethodTaxLineProps> {
+    /**
+     * The IDs to filter the order shipping method tax lines by.
+     */
     id?: string | string[];
+    /**
+     * Filter the tax lines by their description
+     */
     description?: string;
+    /**
+     * Filter the tax lines by their code.
+     */
     code?: string | string[];
+    /**
+     * Filter the tax lines by their associated tax rate's ID.
+     */
     tax_rate_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated provider's ID.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter the tax lines by their associated shipping method's ID.
+     */
     shipping_method_id?: string | string[];
+    /**
+     * The filters to apply on the retrieved associated shipping methods.
+     */
     shipping_method?: FilterableOrderShippingMethodProps;
 }
+/**
+ * The filters to apply on the retrieved order changes.
+ */
 export interface FilterableOrderChangeProps extends BaseFilterable<FilterableOrderChangeProps> {
+    /**
+     * The IDs to filter the order changes by.
+     */
     id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the changes by their associated order's ID.
+     */
     order_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by their status.
+     */
     status?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by who requested them.
+     */
     requested_by?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by who confirmed them.
+     */
     confirmed_by?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by who declined them.
+     */
     declined_by?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by who canceled them.
+     */
     canceled_by?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order changes by their creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter the order changes by their update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter the order changes by their deletion date.
+     */
     deleted_at?: OperatorMap<string>;
+    /**
+     * Filter the order changes by their cancelation date.
+     */
     canceled_at?: OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved order change actions.
+ */
 export interface FilterableOrderChangeActionProps extends BaseFilterable<FilterableOrderChangeActionProps> {
+    /**
+     * The IDs to filter the order change actions by.
+     */
     id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the actions by their associated order change's ID.
+     */
     order_change_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the actions by their reference.
+     */
     reference?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the actions by their reference ID.
+     */
     reference_id?: string | string[] | OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved transactions.
+ */
 export interface FilterableOrderTransactionProps extends BaseFilterable<FilterableOrderTransactionProps> {
+    /**
+     * The IDs to filter the transactions by.
+     */
     id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the transactions by their associated order's ID.
+     */
     order_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the transactions by their currency code.
+     */
     currency_code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the transactions by their reference.
+     */
     reference?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the transactions by their associated reference's ID.
+     */
     reference_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the transactions by their creation date.
+     */
     created_at?: OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved order items.
+ */
 export interface FilterableOrderItemProps extends BaseFilterable<FilterableOrderItemProps> {
+    /**
+     * The IDs to filter the order items by.
+     */
     id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order items by their associated order's ID.
+     */
     order_id?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order items by their version.
+     */
     version?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter the order items by their associated line item's ID.
+     */
     item_id?: string | string[] | OperatorMap<string>;
 }
+/**
+ * The filters to apply on the retrieved return reasons.
+ */
 export interface FilterableOrderReturnReasonProps extends BaseFilterable<FilterableOrderReturnReasonProps> {
+    /**
+     * The IDs to filter the return reasons by.
+     */
     id?: string | string[];
+    /**
+     * Filter the return reason by their value.
+     */
     value?: string | string[];
+    /**
+     * Filter the return reason by their label.
+     */
     label?: string;
+    /**
+     * Filter the return reason by their description.
+     */
     description?: string;
 }
+/**
+ * The filters to apply on the retrieved returns.
+ */
 export interface FilterableReturnProps extends BaseFilterable<FilterableReturnProps> {
+    /**
+     * The IDs to filter the returns by.
+     */
     id?: string | string[];
+    /**
+     * Filter the returns by their associated order's ID.
+     */
     order_id?: string | string[];
+    /**
+     * Filter the returns by their associated claim's ID.
+     */
     claim_id?: string | string[];
+    /**
+     * Filter the returns by their associated exchange's ID.
+     */
     exchange_id?: string | string[];
+    /**
+     * Filter the returns by their status.
+     */
     status?: string | string[];
+    /**
+     * Filter the returns by their refund amount.
+     */
     refund_amount?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved claims.
+ */
 export interface FilterableOrderClaimProps extends BaseFilterable<FilterableOrderClaimProps> {
+    /**
+     * The IDs to filter the claims by.
+     */
     id?: string | string[];
+    /**
+     * Filter the claims by their associated order's ID.
+     */
     order_id?: string | string[];
+    /**
+     * Filter the claims by their associated return's ID.
+     */
     return_id?: string | string[];
 }
+/**
+ * The filters to apply on the retrieved exchanges.
+ */
 export interface FilterableOrderExchangeProps extends BaseFilterable<FilterableOrderExchangeProps> {
+    /**
+     * The IDs to filter the exchanges by.
+     */
     id?: string | string[];
+    /**
+     * Filter the exchanges by their associated order's ID.
+     */
     order_id?: string | string[];
+    /**
+     * Filter the exchanges by their associated return's ID.
+     */
     return_id?: string | string[];
+    /**
+     * Filter the exchanges by whether backorders are allowed.
+     */
     allow_backorder?: boolean;
 }
+/**
+ * The details of changes made on orders.
+ */
 export interface OrderChangeReturn {
+    /**
+     * The list of items created or updated.
+     */
     items: {
+        /**
+         * The associated item's ID.
+         */
         item_id: string;
+        /**
+         * The associated order's ID.
+         */
         order_id: string;
+        /**
+         * The item's fulfilled quantity.
+         */
         fulfilled_quantity: BigNumberInput;
+        /**
+         * The item's shipped quantity.
+         */
         shipped_quantity: BigNumberInput;
+        /**
+         * The item's request quantity to be returned.
+         */
         return_requested_quantity: BigNumberInput;
+        /**
+         * The item's quantity that was received through a return.
+         */
         return_received_quantity: BigNumberInput;
+        /**
+         * The item's quantity that was dismissed in a return.
+         */
         return_dismissed_quantity: BigNumberInput;
+        /**
+         * The item's quantity that was written off.
+         */
         written_off_quantity: BigNumberInput;
+        /**
+         * Other details updated in an item.
+         */
         [key: string]: any;
     }[];
+    /**
+     * The list of shipping methods created or updated.
+     */
     shippingMethods: any[];
 }
 export {};