--- displayed_sidebar: jsClientSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # internal ## Namespaces - [EventEmitter](../internal/modules/internal.EventEmitter.mdx) - [internal](../internal/modules/internal.internal.mdx) - [internal](../internal/modules/internal.internal-1.mdx) - [internal](../internal/modules/internal.internal-2.mdx) - [internal](../internal/modules/internal.internal-3.mdx) - [internal](../internal/modules/internal.internal-4.mdx) - [internal](../internal/modules/internal.internal-5.mdx) ## Enumerations - [CartType](../internal/enums/internal.CartType.mdx) - [DefaultPriceType](../internal/enums/internal.DefaultPriceType.mdx) - [DiscountConditionJoinTableForeignKey](../internal/enums/internal.DiscountConditionJoinTableForeignKey.mdx) - [DiscountConditionOperator](../internal/enums/internal.DiscountConditionOperator.mdx) - [FulfillmentStatus](../internal/enums/internal.FulfillmentStatus.mdx) - [FulfillmentStatus](../internal/enums/internal.FulfillmentStatus-1.mdx) - [OrderEditStatus](../internal/enums/internal.OrderEditStatus.mdx) - [OrderStatus](../internal/enums/internal.OrderStatus.mdx) - [OrderStatus](../internal/enums/internal.OrderStatus-1.mdx) - [PaymentCollectionStatus](../internal/enums/internal.PaymentCollectionStatus.mdx) - [PaymentStatus](../internal/enums/internal.PaymentStatus.mdx) - [PaymentStatus](../internal/enums/internal.PaymentStatus-1.mdx) - [PriceListStatus](../internal/enums/internal.PriceListStatus.mdx) - [PriceListType](../internal/enums/internal.PriceListType.mdx) - [ProductStatus](../internal/enums/internal.ProductStatus.mdx) - [RefundReason](../internal/enums/internal.RefundReason.mdx) - [ShippingProfileType](../internal/enums/internal.ShippingProfileType.mdx) - [SwapFulfillmentStatus](../internal/enums/internal.SwapFulfillmentStatus.mdx) - [SwapPaymentStatus](../internal/enums/internal.SwapPaymentStatus.mdx) ## Classes - [AbstractEventBusModuleService](../internal/classes/internal.AbstractEventBusModuleService.mdx) - [AbstractSearchService](../internal/classes/internal.AbstractSearchService.mdx) - [AdditionalItem](../internal/classes/internal.AdditionalItem.mdx) - [AdditionalItem](../internal/classes/internal.AdditionalItem-1.mdx) - [AdditionalItem](../internal/classes/internal.AdditionalItem-2.mdx) - [Address](../internal/classes/internal.Address.mdx) - [AddressCreatePayload](../internal/classes/internal.AddressCreatePayload.mdx) - [AddressPayload](../internal/classes/internal.AddressPayload.mdx) - [AdminCreateUserRequest](../internal/classes/internal.AdminCreateUserRequest.mdx) - [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../internal/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx) - [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../internal/classes/internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx) - [AdminDeletePriceListPricesPricesReq](../internal/classes/internal.AdminDeletePriceListPricesPricesReq.mdx) - [AdminDeletePriceListsPriceListProductsPricesBatchReq](../internal/classes/internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx) - [AdminDeleteProductCategoriesCategoryProductsBatchReq](../internal/classes/internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx) - [AdminDeleteProductsFromCollectionReq](../internal/classes/internal.AdminDeleteProductsFromCollectionReq.mdx) - [AdminDeletePublishableApiKeySalesChannelsBatchReq](../internal/classes/internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx) - [AdminDeleteSalesChannelsChannelProductsBatchReq](../internal/classes/internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx) - [AdminDeleteSalesChannelsChannelStockLocationsReq](../internal/classes/internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx) - [AdminDeleteTaxRatesTaxRateProductTypesParams](../internal/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx) - [AdminDeleteTaxRatesTaxRateProductTypesReq](../internal/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx) - [AdminDeleteTaxRatesTaxRateProductsParams](../internal/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx) - [AdminDeleteTaxRatesTaxRateProductsReq](../internal/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx) - [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../internal/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx) - [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../internal/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx) - [AdminDeleteUploadsReq](../internal/classes/internal.AdminDeleteUploadsReq.mdx) - [AdminGetBatchPaginationParams](../internal/classes/internal.AdminGetBatchPaginationParams.mdx) - [AdminGetBatchParams](../internal/classes/internal.AdminGetBatchParams.mdx) - [AdminGetCollectionsPaginationParams](../internal/classes/internal.AdminGetCollectionsPaginationParams.mdx) - [AdminGetCollectionsParams](../internal/classes/internal.AdminGetCollectionsParams.mdx) - [AdminGetCurrenciesParams](../internal/classes/internal.AdminGetCurrenciesParams.mdx) - [AdminGetCustomerGroupsGroupParams](../internal/classes/internal.AdminGetCustomerGroupsGroupParams.mdx) - [AdminGetCustomerGroupsParams](../internal/classes/internal.AdminGetCustomerGroupsParams.mdx) - [AdminGetCustomersParams](../internal/classes/internal.AdminGetCustomersParams.mdx) - [AdminGetDiscountsDiscountConditionsConditionParams](../internal/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx) - [AdminGetDiscountsDiscountRuleParams](../internal/classes/internal.AdminGetDiscountsDiscountRuleParams.mdx) - [AdminGetDiscountsParams](../internal/classes/internal.AdminGetDiscountsParams.mdx) - [AdminGetDraftOrdersParams](../internal/classes/internal.AdminGetDraftOrdersParams.mdx) - [AdminGetGiftCardsParams](../internal/classes/internal.AdminGetGiftCardsParams.mdx) - [AdminGetInventoryItemsItemLocationLevelsParams](../internal/classes/internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx) - [AdminGetInventoryItemsItemParams](../internal/classes/internal.AdminGetInventoryItemsItemParams.mdx) - [AdminGetInventoryItemsParams](../internal/classes/internal.AdminGetInventoryItemsParams.mdx) - [AdminGetNotesParams](../internal/classes/internal.AdminGetNotesParams.mdx) - [AdminGetNotificationsParams](../internal/classes/internal.AdminGetNotificationsParams.mdx) - [AdminGetOrdersParams](../internal/classes/internal.AdminGetOrdersParams.mdx) - [AdminGetPaymentCollectionsParams](../internal/classes/internal.AdminGetPaymentCollectionsParams.mdx) - [AdminGetPriceListPaginationParams](../internal/classes/internal.AdminGetPriceListPaginationParams.mdx) - [AdminGetPriceListsPriceListProductsParams](../internal/classes/internal.AdminGetPriceListsPriceListProductsParams.mdx) - [AdminGetProductCategoriesParams](../internal/classes/internal.AdminGetProductCategoriesParams.mdx) - [AdminGetProductCategoryParams](../internal/classes/internal.AdminGetProductCategoryParams.mdx) - [AdminGetProductTagsPaginationParams](../internal/classes/internal.AdminGetProductTagsPaginationParams.mdx) - [AdminGetProductTagsParams](../internal/classes/internal.AdminGetProductTagsParams.mdx) - [AdminGetProductTypesParams](../internal/classes/internal.AdminGetProductTypesParams.mdx) - [AdminGetProductsParams](../internal/classes/internal.AdminGetProductsParams.mdx) - [AdminGetRegionsPaginationParams](../internal/classes/internal.AdminGetRegionsPaginationParams.mdx) - [AdminGetRegionsParams](../internal/classes/internal.AdminGetRegionsParams.mdx) - [AdminGetRegionsRegionFulfillmentOptionsRes](../internal/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx) - [AdminGetReservationsParams](../internal/classes/internal.AdminGetReservationsParams.mdx) - [AdminGetReturnsParams](../internal/classes/internal.AdminGetReturnsParams.mdx) - [AdminGetSalesChannelsParams](../internal/classes/internal.AdminGetSalesChannelsParams.mdx) - [AdminGetShippingOptionsParams](../internal/classes/internal.AdminGetShippingOptionsParams.mdx) - [AdminGetStockLocationsParams](../internal/classes/internal.AdminGetStockLocationsParams.mdx) - [AdminGetSwapsParams](../internal/classes/internal.AdminGetSwapsParams.mdx) - [AdminGetTaxRatesParams](../internal/classes/internal.AdminGetTaxRatesParams.mdx) - [AdminGetTaxRatesTaxRateParams](../internal/classes/internal.AdminGetTaxRatesTaxRateParams.mdx) - [AdminGetVariantParams](../internal/classes/internal.AdminGetVariantParams.mdx) - [AdminGetVariantsParams](../internal/classes/internal.AdminGetVariantsParams.mdx) - [AdminListCustomerSelector](../internal/classes/internal.AdminListCustomerSelector.mdx) - [AdminListOrdersSelector](../internal/classes/internal.AdminListOrdersSelector.mdx) - [AdminPostAuthReq](../internal/classes/internal.AdminPostAuthReq.mdx) - [AdminPostBatchesReq](../internal/classes/internal.AdminPostBatchesReq.mdx) - [AdminPostCollectionsCollectionReq](../internal/classes/internal.AdminPostCollectionsCollectionReq.mdx) - [AdminPostCollectionsReq](../internal/classes/internal.AdminPostCollectionsReq.mdx) - [AdminPostCurrenciesCurrencyReq](../internal/classes/internal.AdminPostCurrenciesCurrencyReq.mdx) - [AdminPostCustomerGroupsGroupCustomersBatchReq](../internal/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx) - [AdminPostCustomerGroupsGroupReq](../internal/classes/internal.AdminPostCustomerGroupsGroupReq.mdx) - [AdminPostCustomerGroupsReq](../internal/classes/internal.AdminPostCustomerGroupsReq.mdx) - [AdminPostCustomersCustomerReq](../internal/classes/internal.AdminPostCustomersCustomerReq.mdx) - [AdminPostCustomersReq](../internal/classes/internal.AdminPostCustomersReq.mdx) - [AdminPostDiscountsDiscountConditions](../internal/classes/internal.AdminPostDiscountsDiscountConditions.mdx) - [AdminPostDiscountsDiscountConditionsCondition](../internal/classes/internal.AdminPostDiscountsDiscountConditionsCondition.mdx) - [AdminPostDiscountsDiscountConditionsConditionBatchParams](../internal/classes/internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx) - [AdminPostDiscountsDiscountConditionsConditionBatchReq](../internal/classes/internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx) - [AdminPostDiscountsDiscountConditionsConditionParams](../internal/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx) - [AdminPostDiscountsDiscountConditionsParams](../internal/classes/internal.AdminPostDiscountsDiscountConditionsParams.mdx) - [AdminPostDiscountsDiscountDynamicCodesReq](../internal/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx) - [AdminPostDiscountsDiscountReq](../internal/classes/internal.AdminPostDiscountsDiscountReq.mdx) - [AdminPostDiscountsDiscountRule](../internal/classes/internal.AdminPostDiscountsDiscountRule.mdx) - [AdminPostDiscountsReq](../internal/classes/internal.AdminPostDiscountsReq.mdx) - [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../internal/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx) - [AdminPostDraftOrdersDraftOrderLineItemsReq](../internal/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx) - [AdminPostDraftOrdersDraftOrderReq](../internal/classes/internal.AdminPostDraftOrdersDraftOrderReq.mdx) - [AdminPostDraftOrdersReq](../internal/classes/internal.AdminPostDraftOrdersReq.mdx) - [AdminPostGiftCardsGiftCardReq](../internal/classes/internal.AdminPostGiftCardsGiftCardReq.mdx) - [AdminPostGiftCardsReq](../internal/classes/internal.AdminPostGiftCardsReq.mdx) - [AdminPostInventoryItemsInventoryItemParams](../internal/classes/internal.AdminPostInventoryItemsInventoryItemParams.mdx) - [AdminPostInventoryItemsInventoryItemReq](../internal/classes/internal.AdminPostInventoryItemsInventoryItemReq.mdx) - [AdminPostInventoryItemsItemLocationLevelsLevelParams](../internal/classes/internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx) - [AdminPostInventoryItemsItemLocationLevelsLevelReq](../internal/classes/internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx) - [AdminPostInventoryItemsItemLocationLevelsParams](../internal/classes/internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx) - [AdminPostInventoryItemsItemLocationLevelsReq](../internal/classes/internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx) - [AdminPostInventoryItemsParams](../internal/classes/internal.AdminPostInventoryItemsParams.mdx) - [AdminPostInventoryItemsReq](../internal/classes/internal.AdminPostInventoryItemsReq.mdx) - [AdminPostInvitesInviteAcceptReq](../internal/classes/internal.AdminPostInvitesInviteAcceptReq.mdx) - [AdminPostInvitesInviteAcceptUserReq](../internal/classes/internal.AdminPostInvitesInviteAcceptUserReq.mdx) - [AdminPostInvitesReq](../internal/classes/internal.AdminPostInvitesReq.mdx) - [AdminPostNotesNoteReq](../internal/classes/internal.AdminPostNotesNoteReq.mdx) - [AdminPostNotesReq](../internal/classes/internal.AdminPostNotesReq.mdx) - [AdminPostNotificationsNotificationResendReq](../internal/classes/internal.AdminPostNotificationsNotificationResendReq.mdx) - [AdminPostOrderEditsEditLineItemsLineItemReq](../internal/classes/internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx) - [AdminPostOrderEditsEditLineItemsReq](../internal/classes/internal.AdminPostOrderEditsEditLineItemsReq.mdx) - [AdminPostOrderEditsOrderEditReq](../internal/classes/internal.AdminPostOrderEditsOrderEditReq.mdx) - [AdminPostOrderEditsReq](../internal/classes/internal.AdminPostOrderEditsReq.mdx) - [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx) - [AdminPostOrdersOrderClaimsClaimReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimReq.mdx) - [AdminPostOrdersOrderClaimsClaimShipmentsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx) - [AdminPostOrdersOrderClaimsReq](../internal/classes/internal.AdminPostOrdersOrderClaimsReq.mdx) - [AdminPostOrdersOrderFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderFulfillmentsReq.mdx) - [AdminPostOrdersOrderRefundsReq](../internal/classes/internal.AdminPostOrdersOrderRefundsReq.mdx) - [AdminPostOrdersOrderReq](../internal/classes/internal.AdminPostOrdersOrderReq.mdx) - [AdminPostOrdersOrderReturnsReq](../internal/classes/internal.AdminPostOrdersOrderReturnsReq.mdx) - [AdminPostOrdersOrderShipmentReq](../internal/classes/internal.AdminPostOrdersOrderShipmentReq.mdx) - [AdminPostOrdersOrderShippingMethodsReq](../internal/classes/internal.AdminPostOrdersOrderShippingMethodsReq.mdx) - [AdminPostOrdersOrderSwapsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsReq.mdx) - [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx) - [AdminPostOrdersOrderSwapsSwapShipmentsReq](../internal/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx) - [AdminPostPaymentRefundsReq](../internal/classes/internal.AdminPostPaymentRefundsReq.mdx) - [AdminPostPriceListPricesPricesReq](../internal/classes/internal.AdminPostPriceListPricesPricesReq.mdx) - [AdminPostPriceListsPriceListPriceListReq](../internal/classes/internal.AdminPostPriceListsPriceListPriceListReq.mdx) - [AdminPostPriceListsPriceListReq](../internal/classes/internal.AdminPostPriceListsPriceListReq.mdx) - [AdminPostProductCategoriesCategoryProductsBatchReq](../internal/classes/internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx) - [AdminPostProductCategoriesCategoryReq](../internal/classes/internal.AdminPostProductCategoriesCategoryReq.mdx) - [AdminPostProductCategoriesReq](../internal/classes/internal.AdminPostProductCategoriesReq.mdx) - [AdminPostProductsProductMetadataReq](../internal/classes/internal.AdminPostProductsProductMetadataReq.mdx) - [AdminPostProductsProductOptionsOption](../internal/classes/internal.AdminPostProductsProductOptionsOption.mdx) - [AdminPostProductsProductOptionsReq](../internal/classes/internal.AdminPostProductsProductOptionsReq.mdx) - [AdminPostProductsProductReq](../internal/classes/internal.AdminPostProductsProductReq.mdx) - [AdminPostProductsProductVariantsReq](../internal/classes/internal.AdminPostProductsProductVariantsReq.mdx) - [AdminPostProductsProductVariantsVariantReq](../internal/classes/internal.AdminPostProductsProductVariantsVariantReq.mdx) - [AdminPostProductsReq](../internal/classes/internal.AdminPostProductsReq.mdx) - [AdminPostProductsToCollectionReq](../internal/classes/internal.AdminPostProductsToCollectionReq.mdx) - [AdminPostPublishableApiKeySalesChannelsBatchReq](../internal/classes/internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx) - [AdminPostPublishableApiKeysPublishableApiKeyReq](../internal/classes/internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx) - [AdminPostPublishableApiKeysReq](../internal/classes/internal.AdminPostPublishableApiKeysReq.mdx) - [AdminPostRegionsRegionCountriesReq](../internal/classes/internal.AdminPostRegionsRegionCountriesReq.mdx) - [AdminPostRegionsRegionFulfillmentProvidersReq](../internal/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx) - [AdminPostRegionsRegionPaymentProvidersReq](../internal/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.mdx) - [AdminPostRegionsRegionReq](../internal/classes/internal.AdminPostRegionsRegionReq.mdx) - [AdminPostRegionsReq](../internal/classes/internal.AdminPostRegionsReq.mdx) - [AdminPostReservationsReq](../internal/classes/internal.AdminPostReservationsReq.mdx) - [AdminPostReservationsReservationReq](../internal/classes/internal.AdminPostReservationsReservationReq.mdx) - [AdminPostReturnReasonsReasonReq](../internal/classes/internal.AdminPostReturnReasonsReasonReq.mdx) - [AdminPostReturnReasonsReq](../internal/classes/internal.AdminPostReturnReasonsReq.mdx) - [AdminPostReturnsReturnReceiveReq](../internal/classes/internal.AdminPostReturnsReturnReceiveReq.mdx) - [AdminPostSalesChannelsChannelProductsBatchReq](../internal/classes/internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx) - [AdminPostSalesChannelsChannelStockLocationsReq](../internal/classes/internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx) - [AdminPostSalesChannelsReq](../internal/classes/internal.AdminPostSalesChannelsReq.mdx) - [AdminPostSalesChannelsSalesChannelReq](../internal/classes/internal.AdminPostSalesChannelsSalesChannelReq.mdx) - [AdminPostShippingOptionsOptionReq](../internal/classes/internal.AdminPostShippingOptionsOptionReq.mdx) - [AdminPostShippingOptionsReq](../internal/classes/internal.AdminPostShippingOptionsReq.mdx) - [AdminPostShippingProfilesProfileReq](../internal/classes/internal.AdminPostShippingProfilesProfileReq.mdx) - [AdminPostShippingProfilesReq](../internal/classes/internal.AdminPostShippingProfilesReq.mdx) - [AdminPostStockLocationsLocationReq](../internal/classes/internal.AdminPostStockLocationsLocationReq.mdx) - [AdminPostStockLocationsReq](../internal/classes/internal.AdminPostStockLocationsReq.mdx) - [AdminPostStoreReq](../internal/classes/internal.AdminPostStoreReq.mdx) - [AdminPostTaxRatesParams](../internal/classes/internal.AdminPostTaxRatesParams.mdx) - [AdminPostTaxRatesReq](../internal/classes/internal.AdminPostTaxRatesReq.mdx) - [AdminPostTaxRatesTaxRateParams](../internal/classes/internal.AdminPostTaxRatesTaxRateParams.mdx) - [AdminPostTaxRatesTaxRateProductTypesReq](../internal/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx) - [AdminPostTaxRatesTaxRateProductsParams](../internal/classes/internal.AdminPostTaxRatesTaxRateProductsParams.mdx) - [AdminPostTaxRatesTaxRateProductsReq](../internal/classes/internal.AdminPostTaxRatesTaxRateProductsReq.mdx) - [AdminPostTaxRatesTaxRateReq](../internal/classes/internal.AdminPostTaxRatesTaxRateReq.mdx) - [AdminPostTaxRatesTaxRateShippingOptionsParams](../internal/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx) - [AdminPostTaxRatesTaxRateShippingOptionsReq](../internal/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx) - [AdminPostUploadsDownloadUrlReq](../internal/classes/internal.AdminPostUploadsDownloadUrlReq.mdx) - [AdminPriceListPricesCreateReq](../internal/classes/internal.AdminPriceListPricesCreateReq.mdx) - [AdminPriceListPricesUpdateReq](../internal/classes/internal.AdminPriceListPricesUpdateReq.mdx) - [AdminPriceSelectionParams](../internal/classes/internal.AdminPriceSelectionParams.mdx) - [AdminProductCategoriesReqBase](../internal/classes/internal.AdminProductCategoriesReqBase.mdx) - [AdminResetPasswordRequest](../internal/classes/internal.AdminResetPasswordRequest.mdx) - [AdminResetPasswordTokenRequest](../internal/classes/internal.AdminResetPasswordTokenRequest.mdx) - [AdminUpdateDiscountRule](../internal/classes/internal.AdminUpdateDiscountRule.mdx) - [AdminUpdatePaymentCollectionsReq](../internal/classes/internal.AdminUpdatePaymentCollectionsReq.mdx) - [AdminUpdateUserRequest](../internal/classes/internal.AdminUpdateUserRequest.mdx) - [AdminUpsertConditionsReq](../internal/classes/internal.AdminUpsertConditionsReq.mdx) - [AsyncResource](../internal/classes/internal.AsyncResource.mdx) - [Axios](../internal/classes/internal.Axios.mdx) - [BaseEntity](../internal/classes/internal.BaseEntity.mdx) - [BatchJob](../internal/classes/internal.BatchJob.mdx) - [Blob](../internal/classes/internal.Blob.mdx) - [Cart](../internal/classes/internal.Cart.mdx) - [ClaimOrder](../internal/classes/internal.ClaimOrder.mdx) - [Client](../internal/classes/internal.Client.mdx) - [Currency](../internal/classes/internal.Currency.mdx) - [CustomShippingOption](../internal/classes/internal.CustomShippingOption.mdx) - [Customer](../internal/classes/internal.Customer.mdx) - [CustomerGroup](../internal/classes/internal.CustomerGroup.mdx) - [CustomerGroup](../internal/classes/internal.CustomerGroup-1.mdx) - [CustomerGroup](../internal/classes/internal.CustomerGroup-2.mdx) - [CustomerGroupUpdate](../internal/classes/internal.CustomerGroupUpdate.mdx) - [CustomerGroupsBatchCustomer](../internal/classes/internal.CustomerGroupsBatchCustomer.mdx) - [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx) - [Discount](../internal/classes/internal.Discount.mdx) - [Discount](../internal/classes/internal.Discount-1.mdx) - [Discount](../internal/classes/internal.Discount-2.mdx) - [Discount](../internal/classes/internal.Discount-3.mdx) - [Discount](../internal/classes/internal.Discount-4.mdx) - [DiscountCondition](../internal/classes/internal.DiscountCondition.mdx) - [DraftOrder](../internal/classes/internal.DraftOrder.mdx) - [Duplex](../internal/classes/internal.Duplex.mdx) - [EventEmitter](../internal/classes/internal.EventEmitter-1.mdx) - [FilterableCartProps](../internal/classes/internal.FilterableCartProps.mdx) - [FilterableCustomerGroupProps](../internal/classes/internal.FilterableCustomerGroupProps.mdx) - [FilterableDiscountProps](../internal/classes/internal.FilterableDiscountProps.mdx) - [FilterableLineItemAdjustmentProps](../internal/classes/internal.FilterableLineItemAdjustmentProps.mdx) - [FilterablePriceListProps](../internal/classes/internal.FilterablePriceListProps.mdx) - [FilterableProductProps](../internal/classes/internal.FilterableProductProps.mdx) - [FilterableProductVariantProps](../internal/classes/internal.FilterableProductVariantProps.mdx) - [FindPaginationParams](../internal/classes/internal.FindPaginationParams.mdx) - [FindParams](../internal/classes/internal.FindParams.mdx) - [FlagRouter](../internal/classes/internal.FlagRouter.mdx) - [Fulfillment](../internal/classes/internal.Fulfillment.mdx) - [FulfillmentOption](../internal/classes/internal.FulfillmentOption.mdx) - [FulfillmentService](../internal/classes/internal.FulfillmentService.mdx) - [GetOrderEditsOrderEditParams](../internal/classes/internal.GetOrderEditsOrderEditParams.mdx) - [GetOrderEditsParams](../internal/classes/internal.GetOrderEditsParams.mdx) - [GetPaymentsParams](../internal/classes/internal.GetPaymentsParams.mdx) - [GetPublishableApiKeySalesChannelsParams](../internal/classes/internal.GetPublishableApiKeySalesChannelsParams.mdx) - [GetPublishableApiKeysParams](../internal/classes/internal.GetPublishableApiKeysParams.mdx) - [GiftCard](../internal/classes/internal.GiftCard.mdx) - [GiftCard](../internal/classes/internal.GiftCard-1.mdx) - [GiftCard](../internal/classes/internal.GiftCard-2.mdx) - [GiftCardTransaction](../internal/classes/internal.GiftCardTransaction.mdx) - [Group](../internal/classes/internal.Group.mdx) - [Image](../internal/classes/internal.Image.mdx) - [Invite](../internal/classes/internal.Invite.mdx) - [Item](../internal/classes/internal.Item.mdx) - [Item](../internal/classes/internal.Item-1.mdx) - [Item](../internal/classes/internal.Item-2.mdx) - [Item](../internal/classes/internal.Item-3.mdx) - [Item](../internal/classes/internal.Item-4.mdx) - [Item](../internal/classes/internal.Item-5.mdx) - [Item](../internal/classes/internal.Item-6.mdx) - [Item](../internal/classes/internal.Item-7.mdx) - [LineItem](../internal/classes/internal.LineItem.mdx) - [MedusaError](../internal/classes/internal.MedusaError.mdx) - [Note](../internal/classes/internal.Note.mdx) - [Notification](../internal/classes/internal.Notification.mdx) - [NotificationProvider](../internal/classes/internal.NotificationProvider.mdx) - [NumericalComparisonOperator](../internal/classes/internal.NumericalComparisonOperator.mdx) - [OptionRequirement](../internal/classes/internal.OptionRequirement.mdx) - [OptionRequirement](../internal/classes/internal.OptionRequirement-1.mdx) - [Order](../internal/classes/internal.Order.mdx) - [OrderEdit](../internal/classes/internal.OrderEdit.mdx) - [OrderItemChange](../internal/classes/internal.OrderItemChange.mdx) - [OrdersReturnItem](../internal/classes/internal.OrdersReturnItem.mdx) - [PassThrough](../internal/classes/internal.PassThrough.mdx) - [Payment](../internal/classes/internal.Payment.mdx) - [PaymentCollection](../internal/classes/internal.PaymentCollection.mdx) - [PaymentMethod](../internal/classes/internal.PaymentMethod.mdx) - [PaymentProvider](../internal/classes/internal.PaymentProvider.mdx) - [PaymentService](../internal/classes/internal.PaymentService.mdx) - [PaymentSession](../internal/classes/internal.PaymentSession.mdx) - [PriceList](../internal/classes/internal.PriceList.mdx) - [PriceSelectionParams](../internal/classes/internal.PriceSelectionParams.mdx) - [Product](../internal/classes/internal.Product.mdx) - [ProductBatchProductCategory](../internal/classes/internal.ProductBatchProductCategory.mdx) - [ProductBatchSalesChannel](../internal/classes/internal.ProductBatchSalesChannel.mdx) - [ProductCategory](../internal/classes/internal.ProductCategory.mdx) - [ProductCollection](../internal/classes/internal.ProductCollection.mdx) - [ProductOptionReq](../internal/classes/internal.ProductOptionReq.mdx) - [ProductProductCategoryReq](../internal/classes/internal.ProductProductCategoryReq.mdx) - [ProductSalesChannelReq](../internal/classes/internal.ProductSalesChannelReq.mdx) - [ProductTag](../internal/classes/internal.ProductTag.mdx) - [ProductTagReq](../internal/classes/internal.ProductTagReq.mdx) - [ProductType](../internal/classes/internal.ProductType.mdx) - [ProductTypeReq](../internal/classes/internal.ProductTypeReq.mdx) - [ProductVariantOptionReq](../internal/classes/internal.ProductVariantOptionReq.mdx) - [ProductVariantOptionReq](../internal/classes/internal.ProductVariantOptionReq-1.mdx) - [ProductVariantOptionReq](../internal/classes/internal.ProductVariantOptionReq-2.mdx) - [ProductVariantOptionReq](../internal/classes/internal.ProductVariantOptionReq-3.mdx) - [ProductVariantPricesCreateReq](../internal/classes/internal.ProductVariantPricesCreateReq.mdx) - [ProductVariantPricesUpdateReq](../internal/classes/internal.ProductVariantPricesUpdateReq.mdx) - [ProductVariantReq](../internal/classes/internal.ProductVariantReq.mdx) - [ProductVariantReq](../internal/classes/internal.ProductVariantReq-1.mdx) - [PublishableApiKey](../internal/classes/internal.PublishableApiKey.mdx) - [Readable](../internal/classes/internal.Readable.mdx) - [ReadableBase](../internal/classes/internal.ReadableBase.mdx) - [Refund](../internal/classes/internal.Refund.mdx) - [Region](../internal/classes/internal.Region.mdx) - [Return](../internal/classes/internal.Return.mdx) - [ReturnItem](../internal/classes/internal.ReturnItem.mdx) - [ReturnReason](../internal/classes/internal.ReturnReason.mdx) - [ReturnShipping](../internal/classes/internal.ReturnShipping.mdx) - [ReturnShipping](../internal/classes/internal.ReturnShipping-1.mdx) - [ReturnShipping](../internal/classes/internal.ReturnShipping-2.mdx) - [ReturnShipping](../internal/classes/internal.ReturnShipping-3.mdx) - [SalesChannel](../internal/classes/internal.SalesChannel.mdx) - [ShippingAddressPayload](../internal/classes/internal.ShippingAddressPayload.mdx) - [ShippingMethod](../internal/classes/internal.ShippingMethod.mdx) - [ShippingMethod](../internal/classes/internal.ShippingMethod-1.mdx) - [ShippingMethod](../internal/classes/internal.ShippingMethod-2.mdx) - [ShippingMethod](../internal/classes/internal.ShippingMethod-3.mdx) - [ShippingMethod](../internal/classes/internal.ShippingMethod-4.mdx) - [ShippingOption](../internal/classes/internal.ShippingOption.mdx) - [ShippingProfile](../internal/classes/internal.ShippingProfile.mdx) - [Socket](../internal/classes/internal.Socket.mdx) - [SoftDeletableEntity](../internal/classes/internal.SoftDeletableEntity.mdx) - [StockLocationAddress](../internal/classes/internal.StockLocationAddress.mdx) - [StockLocationAddress](../internal/classes/internal.StockLocationAddress-1.mdx) - [Store](../internal/classes/internal.Store.mdx) - [StoreGetCollectionsParams](../internal/classes/internal.StoreGetCollectionsParams.mdx) - [StoreGetCustomersCustomerOrdersPaginationParams](../internal/classes/internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx) - [StoreGetCustomersCustomerOrdersParams](../internal/classes/internal.StoreGetCustomersCustomerOrdersParams.mdx) - [StoreGetOrdersParams](../internal/classes/internal.StoreGetOrdersParams.mdx) - [StoreGetPaymentCollectionsParams](../internal/classes/internal.StoreGetPaymentCollectionsParams.mdx) - [StoreGetProductCategoriesCategoryParams](../internal/classes/internal.StoreGetProductCategoriesCategoryParams.mdx) - [StoreGetProductCategoriesParams](../internal/classes/internal.StoreGetProductCategoriesParams.mdx) - [StoreGetProductTagsParams](../internal/classes/internal.StoreGetProductTagsParams.mdx) - [StoreGetProductTypesParams](../internal/classes/internal.StoreGetProductTypesParams.mdx) - [StoreGetProductsPaginationParams](../internal/classes/internal.StoreGetProductsPaginationParams.mdx) - [StoreGetProductsParams](../internal/classes/internal.StoreGetProductsParams.mdx) - [StoreGetShippingOptionsParams](../internal/classes/internal.StoreGetShippingOptionsParams.mdx) - [StoreGetVariantsParams](../internal/classes/internal.StoreGetVariantsParams.mdx) - [StorePaymentCollectionSessionsReq](../internal/classes/internal.StorePaymentCollectionSessionsReq.mdx) - [StorePostAuthReq](../internal/classes/internal.StorePostAuthReq.mdx) - [StorePostCartReq](../internal/classes/internal.StorePostCartReq.mdx) - [StorePostCartsCartLineItemsItemReq](../internal/classes/internal.StorePostCartsCartLineItemsItemReq.mdx) - [StorePostCartsCartLineItemsReq](../internal/classes/internal.StorePostCartsCartLineItemsReq.mdx) - [StorePostCartsCartPaymentSessionReq](../internal/classes/internal.StorePostCartsCartPaymentSessionReq.mdx) - [StorePostCartsCartPaymentSessionUpdateReq](../internal/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.mdx) - [StorePostCartsCartReq](../internal/classes/internal.StorePostCartsCartReq.mdx) - [StorePostCartsCartShippingMethodReq](../internal/classes/internal.StorePostCartsCartShippingMethodReq.mdx) - [StorePostCustomersCustomerAcceptClaimReq](../internal/classes/internal.StorePostCustomersCustomerAcceptClaimReq.mdx) - [StorePostCustomersCustomerAddressesAddressReq](../internal/classes/internal.StorePostCustomersCustomerAddressesAddressReq.mdx) - [StorePostCustomersCustomerAddressesReq](../internal/classes/internal.StorePostCustomersCustomerAddressesReq.mdx) - [StorePostCustomersCustomerOrderClaimReq](../internal/classes/internal.StorePostCustomersCustomerOrderClaimReq.mdx) - [StorePostCustomersCustomerPasswordTokenReq](../internal/classes/internal.StorePostCustomersCustomerPasswordTokenReq.mdx) - [StorePostCustomersCustomerReq](../internal/classes/internal.StorePostCustomersCustomerReq.mdx) - [StorePostCustomersReq](../internal/classes/internal.StorePostCustomersReq.mdx) - [StorePostCustomersResetPasswordReq](../internal/classes/internal.StorePostCustomersResetPasswordReq.mdx) - [StorePostOrderEditsOrderEditDecline](../internal/classes/internal.StorePostOrderEditsOrderEditDecline.mdx) - [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../internal/classes/internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx) - [StorePostPaymentCollectionsBatchSessionsReq](../internal/classes/internal.StorePostPaymentCollectionsBatchSessionsReq.mdx) - [StorePostPaymentCollectionsSessionsReq](../internal/classes/internal.StorePostPaymentCollectionsSessionsReq.mdx) - [StorePostReturnsReq](../internal/classes/internal.StorePostReturnsReq.mdx) - [StorePostSearchReq](../internal/classes/internal.StorePostSearchReq.mdx) - [StorePostSwapsReq](../internal/classes/internal.StorePostSwapsReq.mdx) - [Stream](../internal/classes/internal.Stream.mdx) - [StringComparisonOperator](../internal/classes/internal.StringComparisonOperator.mdx) - [Swap](../internal/classes/internal.Swap.mdx) - [Tag](../internal/classes/internal.Tag.mdx) - [TaxLine](../internal/classes/internal.TaxLine.mdx) - [TaxProvider](../internal/classes/internal.TaxProvider.mdx) - [TaxRate](../internal/classes/internal.TaxRate.mdx) - [Transform](../internal/classes/internal.Transform.mdx) - [User](../internal/classes/internal.User.mdx) - [WritableBase](../internal/classes/internal.WritableBase.mdx) - [internal](../internal/classes/internal.internal-6.mdx) ## Interfaces - [AddressInfo](../internal/interfaces/internal.AddressInfo.mdx) - [ArrayBufferView](../internal/interfaces/internal.ArrayBufferView.mdx) - [ArrayLike](../internal/interfaces/internal.ArrayLike.mdx) - [ArrayOptions](../internal/interfaces/internal.ArrayOptions.mdx) - [AsyncGenerator](../internal/interfaces/internal.AsyncGenerator.mdx) - [AsyncGeneratorFunction](../internal/interfaces/internal.AsyncGeneratorFunction.mdx) - [AsyncIterable](../internal/interfaces/internal.AsyncIterable.mdx) - [AsyncIterableIterator](../internal/interfaces/internal.AsyncIterableIterator.mdx) - [AsyncIterator](../internal/interfaces/internal.AsyncIterator.mdx) - [AsyncResourceOptions](../internal/interfaces/internal.AsyncResourceOptions.mdx) - [AxiosAdapter](../internal/interfaces/internal.AxiosAdapter.mdx) - [AxiosBasicCredentials](../internal/interfaces/internal.AxiosBasicCredentials.mdx) - [AxiosDefaults](../internal/interfaces/internal.AxiosDefaults.mdx) - [AxiosError](../internal/interfaces/internal.AxiosError.mdx) - [AxiosInstance](../internal/interfaces/internal.AxiosInstance.mdx) - [AxiosInterceptorManager](../internal/interfaces/internal.AxiosInterceptorManager.mdx) - [AxiosPromise](../internal/interfaces/internal.AxiosPromise.mdx) - [AxiosProxyConfig](../internal/interfaces/internal.AxiosProxyConfig.mdx) - [AxiosRequestTransformer](../internal/interfaces/internal.AxiosRequestTransformer.mdx) - [AxiosResponse](../internal/interfaces/internal.AxiosResponse.mdx) - [AxiosResponseTransformer](../internal/interfaces/internal.AxiosResponseTransformer.mdx) - [BaseRepositoryService](../internal/interfaces/internal.BaseRepositoryService.mdx) - [BlobOptions](../internal/interfaces/internal.BlobOptions.mdx) - [BlobPropertyBag](../internal/interfaces/internal.BlobPropertyBag.mdx) - [Boolean](../internal/interfaces/internal.Boolean.mdx) - [Buffer](../internal/interfaces/internal.Buffer.mdx) - [BufferConstructor](../internal/interfaces/internal.BufferConstructor.mdx) - [CallSite](../internal/interfaces/internal.CallSite.mdx) - [Cancel](../internal/interfaces/internal.Cancel.mdx) - [CancelToken](../internal/interfaces/internal.CancelToken.mdx) - [Config](../internal/interfaces/internal.Config.mdx) - [ConnectOpts](../internal/interfaces/internal.ConnectOpts.mdx) - [CreateNoteInput](../internal/interfaces/internal.CreateNoteInput.mdx) - [CreateUserInput](../internal/interfaces/internal.CreateUserInput.mdx) - [DeleteResponse](../internal/interfaces/internal.DeleteResponse.mdx) - [Dict](../internal/interfaces/internal.Dict.mdx) - [Disposable](../internal/interfaces/internal.Disposable.mdx) - [DuplexOptions](../internal/interfaces/internal.DuplexOptions.mdx) - [ErrnoException](../internal/interfaces/internal.ErrnoException.mdx) - [Error](../internal/interfaces/internal.Error.mdx) - [EventEmitter](../internal/interfaces/internal.EventEmitter-2.mdx) - [EventEmitterOptions](../internal/interfaces/internal.EventEmitterOptions.mdx) - [File](../internal/interfaces/internal.File.mdx) - [FilePropertyBag](../internal/interfaces/internal.FilePropertyBag.mdx) - [HTTPResponse](../internal/interfaces/internal.HTTPResponse.mdx) - [HeadersDefaults](../internal/interfaces/internal.HeadersDefaults.mdx) - [ICacheService](../internal/interfaces/internal.ICacheService.mdx) - [IEventBusModuleService](../internal/interfaces/internal.IEventBusModuleService.mdx) - [IEventBusService](../internal/interfaces/internal.IEventBusService.mdx) - [IInventoryService](../internal/interfaces/internal.IInventoryService.mdx) - [IPricingModuleService](../internal/interfaces/internal.IPricingModuleService.mdx) - [IStockLocationService](../internal/interfaces/internal.IStockLocationService.mdx) - [ITransactionBaseService](../internal/interfaces/internal.ITransactionBaseService.mdx) - [IncomingHttpHeaders](../internal/interfaces/internal.IncomingHttpHeaders.mdx) - [IpcSocketConnectOpts](../internal/interfaces/internal.IpcSocketConnectOpts.mdx) - [Iterable](../internal/interfaces/internal.Iterable.mdx) - [IterableIterator](../internal/interfaces/internal.IterableIterator.mdx) - [Iterator](../internal/interfaces/internal.Iterator.mdx) - [IteratorReturnResult](../internal/interfaces/internal.IteratorReturnResult.mdx) - [IteratorYieldResult](../internal/interfaces/internal.IteratorYieldResult.mdx) - [Logger](../internal/interfaces/internal.Logger.mdx) - [LookupAddress](../internal/interfaces/internal.LookupAddress.mdx) - [LookupAllOptions](../internal/interfaces/internal.LookupAllOptions.mdx) - [LookupOptions](../internal/interfaces/internal.LookupOptions.mdx) - [OnReadOpts](../internal/interfaces/internal.OnReadOpts.mdx) - [PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) - [PromiseLike](../internal/interfaces/internal.PromiseLike.mdx) - [QueuingStrategy](../internal/interfaces/internal.QueuingStrategy.mdx) - [QueuingStrategy](../internal/interfaces/internal.QueuingStrategy-1.mdx) - [QueuingStrategySize](../internal/interfaces/internal.QueuingStrategySize.mdx) - [QueuingStrategySize](../internal/interfaces/internal.QueuingStrategySize-1.mdx) - [ReadWriteStream](../internal/interfaces/internal.ReadWriteStream.mdx) - [ReadableByteStreamController](../internal/interfaces/internal.ReadableByteStreamController.mdx) - [ReadableByteStreamController](../internal/interfaces/internal.ReadableByteStreamController-1.mdx) - [ReadableByteStreamControllerCallback](../internal/interfaces/internal.ReadableByteStreamControllerCallback.mdx) - [ReadableOptions](../internal/interfaces/internal.ReadableOptions.mdx) - [ReadableStream](../internal/interfaces/internal.ReadableStream.mdx) - [ReadableStream](../internal/interfaces/internal.ReadableStream-1.mdx) - [ReadableStream](../internal/interfaces/internal.ReadableStream-2.mdx) - [ReadableStreamBYOBReader](../internal/interfaces/internal.ReadableStreamBYOBReader.mdx) - [ReadableStreamBYOBReader](../internal/interfaces/internal.ReadableStreamBYOBReader-1.mdx) - [ReadableStreamBYOBRequest](../internal/interfaces/internal.ReadableStreamBYOBRequest.mdx) - [ReadableStreamDefaultController](../internal/interfaces/internal.ReadableStreamDefaultController.mdx) - [ReadableStreamDefaultController](../internal/interfaces/internal.ReadableStreamDefaultController-1.mdx) - [ReadableStreamDefaultReadDoneResult](../internal/interfaces/internal.ReadableStreamDefaultReadDoneResult.mdx) - [ReadableStreamDefaultReadValueResult](../internal/interfaces/internal.ReadableStreamDefaultReadValueResult.mdx) - [ReadableStreamDefaultReader](../internal/interfaces/internal.ReadableStreamDefaultReader.mdx) - [ReadableStreamDefaultReader](../internal/interfaces/internal.ReadableStreamDefaultReader-1.mdx) - [ReadableStreamErrorCallback](../internal/interfaces/internal.ReadableStreamErrorCallback.mdx) - [ReadableStreamGenericReader](../internal/interfaces/internal.ReadableStreamGenericReader.mdx) - [ReadableStreamGenericReader](../internal/interfaces/internal.ReadableStreamGenericReader-1.mdx) - [ReadableStreamGetReaderOptions](../internal/interfaces/internal.ReadableStreamGetReaderOptions.mdx) - [ReadableStreamReadDoneResult](../internal/interfaces/internal.ReadableStreamReadDoneResult.mdx) - [ReadableStreamReadDoneResult](../internal/interfaces/internal.ReadableStreamReadDoneResult-1.mdx) - [ReadableStreamReadValueResult](../internal/interfaces/internal.ReadableStreamReadValueResult.mdx) - [ReadableStreamReadValueResult](../internal/interfaces/internal.ReadableStreamReadValueResult-1.mdx) - [ReadableWritablePair](../internal/interfaces/internal.ReadableWritablePair.mdx) - [ReadableWritablePair](../internal/interfaces/internal.ReadableWritablePair-1.mdx) - [RequestOptions](../internal/interfaces/internal.RequestOptions.mdx) - [RetryConfig](../internal/interfaces/internal.RetryConfig.mdx) - [SharedArrayBuffer](../internal/interfaces/internal.SharedArrayBuffer.mdx) - [SharedArrayBufferConstructor](../internal/interfaces/internal.SharedArrayBufferConstructor.mdx) - [SocketConstructorOpts](../internal/interfaces/internal.SocketConstructorOpts.mdx) - [StaticEventEmitterOptions](../internal/interfaces/internal.StaticEventEmitterOptions.mdx) - [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions.mdx) - [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions-1.mdx) - [TcpSocketConnectOpts](../internal/interfaces/internal.TcpSocketConnectOpts.mdx) - [TransformOptions](../internal/interfaces/internal.TransformOptions.mdx) - [TransitionalOptions](../internal/interfaces/internal.TransitionalOptions.mdx) - [UnderlyingByteSource](../internal/interfaces/internal.UnderlyingByteSource.mdx) - [UnderlyingByteSource](../internal/interfaces/internal.UnderlyingByteSource-1.mdx) - [UnderlyingDefaultSource](../internal/interfaces/internal.UnderlyingDefaultSource.mdx) - [UnderlyingSink](../internal/interfaces/internal.UnderlyingSink.mdx) - [UnderlyingSink](../internal/interfaces/internal.UnderlyingSink-1.mdx) - [UnderlyingSinkAbortCallback](../internal/interfaces/internal.UnderlyingSinkAbortCallback.mdx) - [UnderlyingSinkAbortCallback](../internal/interfaces/internal.UnderlyingSinkAbortCallback-1.mdx) - [UnderlyingSinkCloseCallback](../internal/interfaces/internal.UnderlyingSinkCloseCallback.mdx) - [UnderlyingSinkCloseCallback](../internal/interfaces/internal.UnderlyingSinkCloseCallback-1.mdx) - [UnderlyingSinkStartCallback](../internal/interfaces/internal.UnderlyingSinkStartCallback.mdx) - [UnderlyingSinkStartCallback](../internal/interfaces/internal.UnderlyingSinkStartCallback-1.mdx) - [UnderlyingSinkWriteCallback](../internal/interfaces/internal.UnderlyingSinkWriteCallback.mdx) - [UnderlyingSinkWriteCallback](../internal/interfaces/internal.UnderlyingSinkWriteCallback-1.mdx) - [UnderlyingSource](../internal/interfaces/internal.UnderlyingSource.mdx) - [UnderlyingSource](../internal/interfaces/internal.UnderlyingSource-1.mdx) - [UnderlyingSourceCancelCallback](../internal/interfaces/internal.UnderlyingSourceCancelCallback.mdx) - [UnderlyingSourceCancelCallback](../internal/interfaces/internal.UnderlyingSourceCancelCallback-1.mdx) - [UnderlyingSourcePullCallback](../internal/interfaces/internal.UnderlyingSourcePullCallback.mdx) - [UnderlyingSourcePullCallback](../internal/interfaces/internal.UnderlyingSourcePullCallback-1.mdx) - [UnderlyingSourceStartCallback](../internal/interfaces/internal.UnderlyingSourceStartCallback.mdx) - [UnderlyingSourceStartCallback](../internal/interfaces/internal.UnderlyingSourceStartCallback-1.mdx) - [UpdateUserInput](../internal/interfaces/internal.UpdateUserInput.mdx) - [WritableStream](../internal/interfaces/internal.WritableStream.mdx) - [WritableStream](../internal/interfaces/internal.WritableStream-1.mdx) - [WritableStream](../internal/interfaces/internal.WritableStream-2.mdx) - [WritableStreamDefaultController](../internal/interfaces/internal.WritableStreamDefaultController.mdx) - [WritableStreamDefaultController](../internal/interfaces/internal.WritableStreamDefaultController-1.mdx) - [WritableStreamDefaultWriter](../internal/interfaces/internal.WritableStreamDefaultWriter.mdx) - [WritableStreamDefaultWriter](../internal/interfaces/internal.WritableStreamDefaultWriter-1.mdx) - [\_DOMEventTarget](../internal/interfaces/internal._DOMEventTarget.mdx) - [\_NodeEventTarget](../internal/interfaces/internal._NodeEventTarget.mdx) ## References ### Abortable Re-exports [Abortable](../EventEmitter/interfaces/internal.EventEmitter.Abortable.mdx) ___ ### AdminCreateCondition Re-exports [AdminCreateCondition](../internal/classes/internal.internal.AdminCreateCondition.mdx) ___ ### AdminUpsertCondition Re-exports [AdminUpsertCondition](../internal/classes/internal.internal.AdminUpsertCondition.mdx) ___ ### AllocationType Re-exports [AllocationType](../internal/enums/internal.internal.AllocationType.mdx) ___ ### BatchJobResultError Re-exports [BatchJobResultError](../internal/modules/internal.internal.mdx#batchjobresulterror) ___ ### BatchJobResultStatDescriptor Re-exports [BatchJobResultStatDescriptor](../internal/modules/internal.internal.mdx#batchjobresultstatdescriptor) ___ ### BatchJobStatus Re-exports [BatchJobStatus](../internal/enums/internal.internal.BatchJobStatus.mdx) ___ ### ClaimReason Re-exports [ClaimReason](../internal/enums/internal.internal.ClaimReason.mdx) ___ ### Country Re-exports [Country](../internal/classes/internal.internal.Country.mdx) ___ ### DiscountConditionType Re-exports [DiscountConditionType](../internal/enums/internal.internal.DiscountConditionType.mdx) ___ ### DiscountRule Re-exports [DiscountRule](../internal/classes/internal.internal.DiscountRule.mdx) ___ ### DiscountRuleType Re-exports [DiscountRuleType](../internal/enums/internal.internal.DiscountRuleType.mdx) ___ ### DraftOrderStatus Re-exports [DraftOrderStatus](../internal/enums/internal.internal.DraftOrderStatus.mdx) ___ ### FulfillmentProvider Re-exports [FulfillmentProvider](../internal/classes/internal.internal.FulfillmentProvider.mdx) ___ ### Image Re-exports [Image](../internal/classes/internal.internal.Image.mdx) ___ ### ModulesResponse Re-exports [ModulesResponse](../internal-1/modules/internal.internal-1.ModulesSdkTypes.mdx#modulesresponse) ___ ### MoneyAmount Re-exports [MoneyAmount](../internal/classes/internal.internal.MoneyAmount.mdx) ___ ### ProductOption Re-exports [ProductOption](../internal/classes/internal.internal.ProductOption.mdx) ___ ### ProductVariant Re-exports [ProductVariant](../internal/classes/internal.internal.ProductVariant.mdx) ___ ### ResponseInventoryItem Re-exports [ResponseInventoryItem](../internal/modules/internal.internal.mdx#responseinventoryitem) ___ ### ReturnItem Re-exports [ReturnItem](../internal/classes/internal.internal.ReturnItem.mdx) ___ ### ReturnStatus Re-exports [ReturnStatus](../internal/enums/internal.internal.ReturnStatus.mdx) ___ ### SalesChannelLocation Re-exports [SalesChannelLocation](../internal/classes/internal.internal.SalesChannelLocation.mdx) ___ ### ShippingOptionPriceType Re-exports [ShippingOptionPriceType](../internal/enums/internal.internal.ShippingOptionPriceType.mdx) ___ ### ShippingOptionRequirement Re-exports [ShippingOptionRequirement](../internal/classes/internal.internal.ShippingOptionRequirement.mdx) ___ ### StockLocationAddressDTO Re-exports [StockLocationAddressDTO](../internal-1/modules/internal.internal-1.StockLocationTypes.mdx#stocklocationaddressdto) ___ ### StreamOptions Re-exports [StreamOptions](../internal-3/interfaces/internal.internal-3.StreamOptions.mdx) ___ ### UserRoles Re-exports [UserRoles](../internal/enums/internal.internal.UserRoles.mdx) ___ ### WritableOptions Re-exports [WritableOptions](../internal-3/interfaces/internal.internal-3.WritableOptions.mdx) ## Enumeration Members ### DEFAULT **DEFAULT**: ``"default"`` ___ ### ORDER\_EDIT **ORDER\_EDIT**: ``"order_edit"`` The payment collection is used for an order edit. ## Type Aliases ### AddOrderEditLineItemInput **AddOrderEditLineItemInput**: `Object` #### Type declaration ", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ]} /> ___ ### AdjustmentContext **AdjustmentContext**: `Object` #### Type declaration ___ ### AdminAuthRes **AdminAuthRes**: `Object` The user's details. #### Type declaration ", "description": "User details.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "api_token", "type": "`string`", "description": "An API token associated with the user.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The email of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The first name of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The user's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The last name of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "role", "type": "[`UserRoles`](../internal/enums/internal.internal.UserRoles.mdx)", "description": "The user's role. These roles don't provide any different privileges.", "optional": false, "defaultValue": "member", "expandable": false, "children": [ { "name": "ADMIN", "type": "``\"admin\"``", "description": "The user is an admin.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEVELOPER", "type": "``\"developer\"``", "description": "The user is a developer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "MEMBER", "type": "``\"member\"``", "description": "The user is a team member.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminBatchJobListRes **AdminBatchJobListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `batch_jobs`: [`BatchJob`](../internal/classes/internal.BatchJob.mdx)[] } ___ ### AdminBatchJobRes **AdminBatchJobRes**: `Object` The batch job's details. #### Type declaration ", "description": "The context of the batch job, the type of the batch job determines what the context should contain.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "``null`` \\| `string`", "description": "The unique identifier of the user that created the batch job.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by_user", "type": "[`User`](../internal/classes/internal.User.mdx)", "description": "The details of the user that created the batch job.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "api_token", "type": "`string`", "description": "An API token associated with the user.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The email of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The first name of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The user's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The last name of the User", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "role", "type": "[`UserRoles`](../internal/enums/internal.internal.UserRoles.mdx)", "description": "The user's role. These roles don't provide any different privileges.", "optional": false, "defaultValue": "member", "expandable": false, "children": [ { "name": "ADMIN", "type": "``\"admin\"``", "description": "The user is an admin.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEVELOPER", "type": "``\"developer\"``", "description": "The user is a developer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "MEMBER", "type": "``\"member\"``", "description": "The user is a team member.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "dry_run", "type": "`boolean`", "description": "Specify if the job must apply the modifications or not.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "failed_at", "type": "`Date`", "description": "The date when the job failed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The unique identifier for the batch job.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "pre_processed_at", "type": "`Date`", "description": "The date from which the job has been pre-processed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "processing_at", "type": "`Date`", "description": "The date the job is processing at.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "result", "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| [`BatchJobResultError`](../internal/modules/internal.internal.mdx#batchjobresulterror))[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../internal/modules/internal.internal.mdx#batchjobresultstatdescriptor)[] } & Record<`string`, `unknown`\\>", "description": "The result of the batch job.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "advancement_count", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "count", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "errors", "type": "(`string` \\| [`BatchJobResultError`](../internal/modules/internal.internal.mdx#batchjobresulterror))[]", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "file_key", "type": "`string`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "file_size", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "progress", "type": "`number`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "stat_descriptors", "type": "[`BatchJobResultStatDescriptor`](../internal/modules/internal.internal.mdx#batchjobresultstatdescriptor)[]", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "status", "type": "[`BatchJobStatus`](../internal/enums/internal.internal.BatchJobStatus.mdx)", "description": "The status of the batch job.", "optional": false, "defaultValue": "created", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CREATED", "type": "``\"created\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FAILED", "type": "``\"failed\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PRE_PROCESSED", "type": "``\"pre_processed\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PROCESSING", "type": "``\"processing\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "`string`", "description": "The type of batch job.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was last updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminBearerAuthRes **AdminBearerAuthRes**: `Object` The access token of the user, if they're authenticated successfully. #### Type declaration ___ ### AdminCollectionsListRes **AdminCollectionsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `collections`: [`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)[] } ___ ### AdminCollectionsRes **AdminCollectionsRes**: `Object` The collection's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this product collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "categories", "type": "[`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)[]", "description": "The details of the product categories that this product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "featureFlag": "product_categories", "children": [ { "name": "category_children", "type": "[`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)[]", "description": "The details of the category's children.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The product category's description.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "`string`", "description": "A unique string that identifies the Product Category - can for example be used in slug structures.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product category's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_active", "type": "[`Boolean`](internal.mdx#boolean)", "description": "A flag to make product category visible/hidden in the store front", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_internal", "type": "[`Boolean`](internal.mdx#boolean)", "description": "A flag to make product category an internal category for admins", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The product category's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_category", "type": "``null`` \\| [`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_category_id", "type": "``null`` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this category.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rank", "type": "`number`", "description": "An integer that depicts the rank of category in a tree node", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "collection", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)", "description": "The details of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "`string`", "description": "A unique string that identifies the Product Collection - can for example be used in slug structures.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this product collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "title", "type": "`string`", "description": "The title that the Product Collection is identified by.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "collection_id", "type": "``null`` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discountable", "type": "`boolean`", "description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "``null`` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "images", "type": "[`Image`](../internal/classes/internal.internal.Image.mdx)[]", "description": "The details of the product's images.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The image's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "url", "type": "`string`", "description": "The URL at which the image file can be found.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOption`](../internal/classes/internal.internal.ProductOption.mdx)[]", "description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product option's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that this product option belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that this product option belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title that the Product Option is defined by (e.g. `Size`).", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "values", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the values of the product option.", "optional": false, "defaultValue": "", "expandable": true, "children": [] } ] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)", "description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping profile's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping profile - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]", "description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)", "description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "profile_id", "type": "`string`", "description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profiles", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)[]", "description": "Available if the relation `profiles` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping profile's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping profile - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]", "description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)", "description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channels", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)[]", "description": "The details of the sales channels this product is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "status", "type": "[`ProductStatus`](../internal/enums/internal.ProductStatus.mdx)", "description": "The status of the product", "optional": false, "defaultValue": "draft", "expandable": false, "children": [ { "name": "DRAFT", "type": "``\"draft\"``", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PROPOSED", "type": "``\"proposed\"``", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PUBLISHED", "type": "``\"published\"``", "description": "The product is published.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REJECTED", "type": "``\"rejected\"``", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtitle", "type": "``null`` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "The details of the product tags used in this product.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The ID of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)", "description": "The details of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product type's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value that the Product Type represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type_id", "type": "``null`` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variants", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)[]", "description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "title", "type": "`string`", "description": "The title that the Product Collection is identified by.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminCreateUploadPayload **AdminCreateUploadPayload**: [`File`](internal.mdx#file) \| [`File`](internal.mdx#file)[] ___ ### AdminCreateUserPayload **AdminCreateUserPayload**: [`Omit`](internal.mdx#omit)<[`AdminCreateUserRequest`](../internal/classes/internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal.mdx#createuserroles) } ___ ### AdminCurrenciesListRes **AdminCurrenciesListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `currencies`: [`Currency`](../internal/classes/internal.Currency.mdx)[] } List of currencies with pagination fields. ___ ### AdminCurrenciesRes **AdminCurrenciesRes**: `Object` A currency's details. #### Type declaration ___ ### AdminCustomerGroupsListRes **AdminCustomerGroupsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `customer_groups`: [`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[] } ___ ### AdminCustomerGroupsRes **AdminCustomerGroupsRes**: `Object` The customer group's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The details of the customer groups that the Price List can apply to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The price list's description", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The price list's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the price list prices include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The price list's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The prices that belong to the price list, represented as a Money Amount.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency that the money amount may belong to.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The money amount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "max_quantity", "type": "``null`` \\| `number`", "description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "min_quantity", "type": "``null`` \\| `number`", "description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_list", "type": "``null`` \\| [`PriceList`](../internal/classes/internal.PriceList.mdx)", "description": "The details of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "price_list_id", "type": "``null`` \\| `string`", "description": "The ID of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region that the money amount may belong to.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "`string`", "description": "The ID of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variants", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)[]", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "starts_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PriceListStatus`](../internal/enums/internal.PriceListStatus.mdx)", "description": "The status of the Price List", "optional": false, "defaultValue": "draft", "expandable": false, "children": [ { "name": "ACTIVE", "type": "``\"active\"``", "description": "The price list is active, meaning its prices are applied to customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT", "type": "``\"draft\"``", "description": "The price list is a draft, meaning its not yet applied to customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`PriceListType`](../internal/enums/internal.PriceListType.mdx)", "description": "The type of Price List. This can be one of either `sale` or `override`.", "optional": false, "defaultValue": "sale", "expandable": false, "children": [ { "name": "OVERRIDE", "type": "``\"override\"``", "description": "The price list is used to override original prices for specific conditions.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SALE", "type": "``\"sale\"``", "description": "The price list is used for a sale.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminCustomersListRes **AdminCustomersListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `customers`: [`Customer`](../internal/classes/internal.Customer.mdx)[] } The list of customers with pagination fields. ___ ### AdminCustomersRes **AdminCustomersRes**: `Object` The customer's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The details of the customer groups that the Price List can apply to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The price list's description", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The price list's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the price list prices include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The price list's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The prices that belong to the price list, represented as a Money Amount.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "starts_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PriceListStatus`](../internal/enums/internal.PriceListStatus.mdx)", "description": "The status of the Price List", "optional": false, "defaultValue": "draft", "expandable": false, "children": [] }, { "name": "type", "type": "[`PriceListType`](../internal/enums/internal.PriceListType.mdx)", "description": "The type of Price List. This can be one of either `sale` or `override`.", "optional": false, "defaultValue": "sale", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminDeleteProductsFromCollectionRes **AdminDeleteProductsFromCollectionRes**: `Object` Deletion operation details #### Type declaration ___ ### AdminDiscountConditionsRes **AdminDiscountConditionsRes**: `Object` #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The details of the customer groups that the Price List can apply to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The price list's description", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The price list's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the price list prices include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The price list's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The prices that belong to the price list, represented as a Money Amount.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "starts_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PriceListStatus`](../internal/enums/internal.PriceListStatus.mdx)", "description": "The status of the Price List", "optional": false, "defaultValue": "draft", "expandable": false, "children": [] }, { "name": "type", "type": "[`PriceListType`](../internal/enums/internal.PriceListType.mdx)", "description": "The type of Price List. This can be one of either `sale` or `override`.", "optional": false, "defaultValue": "sale", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule associated with the condition.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allocation", "type": "[`AllocationType`](../internal/enums/internal.internal.AllocationType.mdx)", "description": "The scope that the discount should apply to.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "ITEM", "type": "``\"item\"``", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "TOTAL", "type": "``\"total\"``", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "conditions", "type": "[`DiscountCondition`](../internal/classes/internal.DiscountCondition.mdx)[]", "description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "Customer groups associated with this condition if `type` is `customer_groups`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule associated with the condition.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "discount_rule_id", "type": "`string`", "description": "The ID of the discount rule associated with the condition", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount condition's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "operator", "type": "[`DiscountConditionOperator`](../internal/enums/internal.DiscountConditionOperator.mdx)", "description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_collections", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)[]", "description": "Product collections associated with this condition if `type` is `product_collections`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "Product tags associated with this condition if `type` is `product_tags`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_types", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)[]", "description": "Product types associated with this condition if `type` is `product_types`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "products associated with this condition if `type` is `products`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`DiscountConditionType`](../internal/enums/internal.internal.DiscountConditionType.mdx)", "description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "A short description of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount rule's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`DiscountRuleType`](../internal/enums/internal.internal.DiscountRuleType.mdx)", "description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "FIXED", "type": "``\"fixed\"``", "description": "Discounts that reduce the price by a fixed amount.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FREE_SHIPPING", "type": "``\"free_shipping\"``", "description": "Discounts that sets the shipping price to `0`.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PERCENTAGE", "type": "``\"percentage\"``", "description": "Discounts that reduce the price by a percentage reduction.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the discount represents; this will depend on the type of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "discount_rule_id", "type": "`string`", "description": "The ID of the discount rule associated with the condition", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount condition's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "operator", "type": "[`DiscountConditionOperator`](../internal/enums/internal.DiscountConditionOperator.mdx)", "description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "IN", "type": "``\"in\"``", "description": "The discountable resources are within the specified resources.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_IN", "type": "``\"not_in\"``", "description": "The discountable resources are everything but the specified resources.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "product_collections", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)[]", "description": "Product collections associated with this condition if `type` is `product_collections`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "`string`", "description": "A unique string that identifies the Product Collection - can for example be used in slug structures.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this product collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "categories", "type": "[`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)[]", "description": "The details of the product categories that this product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "featureFlag": "product_categories", "children": [] }, { "name": "collection", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)", "description": "The details of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "collection_id", "type": "``null`` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discountable", "type": "`boolean`", "description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "``null`` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "images", "type": "[`Image`](../internal/classes/internal.internal.Image.mdx)[]", "description": "The details of the product's images.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOption`](../internal/classes/internal.internal.ProductOption.mdx)[]", "description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)", "description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "profile_id", "type": "`string`", "description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profiles", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)[]", "description": "Available if the relation `profiles` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channels", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)[]", "description": "The details of the sales channels this product is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ProductStatus`](../internal/enums/internal.ProductStatus.mdx)", "description": "The status of the product", "optional": false, "defaultValue": "draft", "expandable": false, "children": [] }, { "name": "subtitle", "type": "``null`` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "The details of the product tags used in this product.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)", "description": "The details of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type_id", "type": "``null`` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variants", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)[]", "description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "title", "type": "`string`", "description": "The title that the Product Collection is identified by.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "product_tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "Product tags associated with this condition if `type` is `product_tags`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The ID of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "product_types", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)[]", "description": "Product types associated with this condition if `type` is `product_types`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product type's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value that the Product Type represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "products associated with this condition if `type` is `products`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "categories", "type": "[`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)[]", "description": "The details of the product categories that this product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "featureFlag": "product_categories", "children": [ { "name": "category_children", "type": "[`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)[]", "description": "The details of the category's children.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The product category's description.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "`string`", "description": "A unique string that identifies the Product Category - can for example be used in slug structures.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product category's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_active", "type": "[`Boolean`](internal.mdx#boolean)", "description": "A flag to make product category visible/hidden in the store front", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_internal", "type": "[`Boolean`](internal.mdx#boolean)", "description": "A flag to make product category an internal category for admins", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The product category's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_category", "type": "``null`` \\| [`ProductCategory`](../internal/classes/internal.ProductCategory.mdx)", "description": "The details of the parent of this category.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_category_id", "type": "``null`` \\| `string`", "description": "The ID of the parent category.", "optional": false, "defaultValue": "null", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this category.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rank", "type": "`number`", "description": "An integer that depicts the rank of category in a tree node", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "collection", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)", "description": "The details of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "`string`", "description": "A unique string that identifies the Product Collection - can for example be used in slug structures.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that belong to this product collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "title", "type": "`string`", "description": "The title that the Product Collection is identified by.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "collection_id", "type": "``null`` \\| `string`", "description": "The ID of the product collection that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A short description of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discountable", "type": "`boolean`", "description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The external ID of the product", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "handle", "type": "``null`` \\| `string`", "description": "A unique identifier for the Product (e.g. for slug structure).", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "images", "type": "[`Image`](../internal/classes/internal.internal.Image.mdx)[]", "description": "The details of the product's images.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The image's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "url", "type": "`string`", "description": "The URL at which the image file can be found.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOption`](../internal/classes/internal.internal.ProductOption.mdx)[]", "description": "The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product option's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that this product option belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that this product option belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title that the Product Option is defined by (e.g. `Size`).", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "values", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the values of the product option.", "optional": false, "defaultValue": "", "expandable": true, "children": [] } ] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)", "description": "The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping profile's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping profile - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]", "description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)", "description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "profile_id", "type": "`string`", "description": "The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profiles", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)[]", "description": "Available if the relation `profiles` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping profile's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping profile - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_options", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)[]", "description": "The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ShippingProfileType`](../internal/enums/internal.ShippingProfileType.mdx)", "description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channels", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)[]", "description": "The details of the sales channels this product is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "status", "type": "[`ProductStatus`](../internal/enums/internal.ProductStatus.mdx)", "description": "The status of the product", "optional": false, "defaultValue": "draft", "expandable": false, "children": [ { "name": "DRAFT", "type": "``\"draft\"``", "description": "The product is a draft. It's not viewable by customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PROPOSED", "type": "``\"proposed\"``", "description": "The product is proposed, but not yet published.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PUBLISHED", "type": "``\"published\"``", "description": "The product is published.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REJECTED", "type": "``\"rejected\"``", "description": "The product is rejected. It's not viewable by customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtitle", "type": "``null`` \\| `string`", "description": "An optional subtitle that can be used to further specify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "The details of the product tags used in this product.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The ID of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value of the tag.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL to an image file that can be used to identify the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)", "description": "The details of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product type's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The value that the Product Type represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type_id", "type": "``null`` \\| `string`", "description": "The ID of the product type that the product belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variants", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)[]", "description": "The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`DiscountConditionType`](../internal/enums/internal.internal.DiscountConditionType.mdx)", "description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CUSTOMER_GROUPS", "type": "``\"customer_groups\"``", "description": "The discount condition is used for customer groups.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PRODUCTS", "type": "``\"products\"``", "description": "The discount condition is used for products.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PRODUCT_COLLECTIONS", "type": "``\"product_collections\"``", "description": "The discount condition is used for product collections.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PRODUCT_TAGS", "type": "``\"product_tags\"``", "description": "The discount condition is used for product tags.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PRODUCT_TYPES", "type": "``\"product_types\"``", "description": "The discount condition is used for product types.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminDiscountsListRes **AdminDiscountsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `discounts`: [`Discount`](../internal/classes/internal.Discount-1.mdx)[] } The list of discounts with pagination fields. ___ ### AdminDiscountsRes **AdminDiscountsRes**: `Object` The discount's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allocation", "type": "[`AllocationType`](../internal/enums/internal.internal.AllocationType.mdx)", "description": "The scope that the discount should apply to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "conditions", "type": "[`DiscountCondition`](../internal/classes/internal.DiscountCondition.mdx)[]", "description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "A short description of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount rule's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`DiscountRuleType`](../internal/enums/internal.internal.DiscountRuleType.mdx)", "description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the discount represents; this will depend on the type of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "display_name", "type": "`string`", "description": "The country name appropriate for display.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`number`", "description": "The country's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_2", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_3", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The normalized country name in upper case.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "num_code", "type": "`number`", "description": "The numerical ISO code for the country.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region the country is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the tax provider as given by the tax service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allocation", "type": "[`AllocationType`](../internal/enums/internal.internal.AllocationType.mdx)", "description": "The scope that the discount should apply to.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "ITEM", "type": "``\"item\"``", "description": "The discount should be applied to applicable items in the cart.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "TOTAL", "type": "``\"total\"``", "description": "The discount should be applied to the checkout total.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "conditions", "type": "[`DiscountCondition`](../internal/classes/internal.DiscountCondition.mdx)[]", "description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "Customer groups associated with this condition if `type` is `customer_groups`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule associated with the condition.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "discount_rule_id", "type": "`string`", "description": "The ID of the discount rule associated with the condition", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount condition's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "operator", "type": "[`DiscountConditionOperator`](../internal/enums/internal.DiscountConditionOperator.mdx)", "description": "The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_collections", "type": "[`ProductCollection`](../internal/classes/internal.ProductCollection.mdx)[]", "description": "Product collections associated with this condition if `type` is `product_collections`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_tags", "type": "[`ProductTag`](../internal/classes/internal.ProductTag.mdx)[]", "description": "Product tags associated with this condition if `type` is `product_tags`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_types", "type": "[`ProductType`](../internal/classes/internal.ProductType.mdx)[]", "description": "Product types associated with this condition if `type` is `product_types`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "products", "type": "[`Product`](../internal/classes/internal.Product.mdx)[]", "description": "products associated with this condition if `type` is `products`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`DiscountConditionType`](../internal/enums/internal.internal.DiscountConditionType.mdx)", "description": "The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "A short description of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount rule's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`DiscountRuleType`](../internal/enums/internal.internal.DiscountRuleType.mdx)", "description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "FIXED", "type": "``\"fixed\"``", "description": "Discounts that reduce the price by a fixed amount.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FREE_SHIPPING", "type": "``\"free_shipping\"``", "description": "Discounts that sets the shipping price to `0`.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PERCENTAGE", "type": "``\"percentage\"``", "description": "Discounts that reduce the price by a percentage reduction.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the discount represents; this will depend on the type of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminDraftOrdersListRes **AdminDraftOrdersListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `draft_orders`: [`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)[] } The list of draft orders with pagination fields. ___ ### AdminDraftOrdersRes **AdminDraftOrdersRes**: `Object` The list of draft orders. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [ { "name": "CLAIM", "type": "``\"claim\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEFAULT", "type": "``\"default\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT_ORDER", "type": "``\"draft_order\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PAYMENT_LINK", "type": "``\"payment_link\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SWAP", "type": "``\"swap\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [ { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The draft order is completed, and an order has been created from it.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "OPEN", "type": "``\"open\"``", "description": "The draft order is open.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminExtendedStoresRes **AdminExtendedStoresRes**: `Object` The store's details with additional details like payment and tax providers. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "default_sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the store's default sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The store's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "invite_link_template", "type": "``null`` \\| `string`", "description": "A template to generate Invite links from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the Store - this may be displayed to the Customer.", "optional": false, "defaultValue": "Medusa Store", "expandable": false, "children": [] }, { "name": "payment_link_template", "type": "``null`` \\| `string`", "description": "A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap_link_template", "type": "``null`` \\| `string`", "description": "A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "feature_flags", "type": "[`FeatureFlagsResponse`](internal.mdx#featureflagsresponse)", "description": "The feature flags enabled in the store's backend.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`boolean` \\| Record<`string`, `boolean`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The store's fulfillment providers.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "modules", "type": "[`ModulesResponse`](internal.mdx#modulesresponse-1)", "description": "The modules installed in the store's backend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The store's payment providers.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] } ] } ]} /> ___ ### AdminGetVariantsVariantInventoryRes **AdminGetVariantsVariantInventoryRes**: `Object` The variant's inventory details. #### Type declaration ___ ### AdminGiftCardsListRes **AdminGiftCardsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `gift_cards`: [`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[] } The list of gift cards with pagination fields. ___ ### AdminGiftCardsRes **AdminGiftCardsRes**: `Object` The gift card's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "display_name", "type": "`string`", "description": "The country name appropriate for display.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`number`", "description": "The country's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_2", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_3", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The normalized country name in upper case.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "num_code", "type": "`number`", "description": "The numerical ISO code for the country.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region the country is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the tax provider as given by the tax service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminInventoryItemsListWithVariantsAndLocationLevelsRes **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `inventory_items`: [`DecoratedInventoryItemDTO`](internal.mdx#decoratedinventoryitemdto)[] } ___ ### AdminInventoryItemsLocationLevelsRes **AdminInventoryItemsLocationLevelsRes**: `Object` Details of inventory items and their associated location levels. #### Type declaration \\| ``null``", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reserved_quantity", "type": "`number`", "description": "the reserved stock quantity of an inventory item at the given location ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "stocked_quantity", "type": "`number`", "description": "the total stock quantity of an inventory item at the given location ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ] }, { "name": "inventory_item.id", "type": "`any`", "description": "The id of the location", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_item.location_levels", "type": "[`InventoryLevelDTO`](internal.mdx#inventoryleveldto)[]", "description": "List of stock levels at a given location", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ]} /> ___ ### AdminInventoryItemsRes **AdminInventoryItemsRes**: `Object` The inventory item's details. #### Type declaration \\| ``null``", "description": "An optional key-value map with additional details", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "`string` \\| ``null``", "description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "origin_country", "type": "`string` \\| ``null``", "description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requires_shipping", "type": "`boolean`", "description": "Whether the item requires shipping.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "`string` \\| ``null``", "description": "The Stock Keeping Unit (SKU) code of the Inventory Item.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "`string` \\| ``null``", "description": "Thumbnail for the inventory item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string` \\| ``null``", "description": "Title of the inventory item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "weight", "type": "`number` \\| ``null``", "description": "The weight of the Inventory Item. May be used in shipping rate calculations.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "`number` \\| ``null``", "description": "The width of the Inventory Item. May be used in shipping rate calculations.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminListInvitesRes **AdminListInvitesRes**: `Object` The list of invites. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "role", "type": "[`UserRoles`](../internal/enums/internal.internal.UserRoles.mdx)", "description": "The user's role. These roles don't change the privileges of the user.", "optional": false, "defaultValue": "member", "expandable": false, "children": [ { "name": "ADMIN", "type": "``\"admin\"``", "description": "The user is an admin.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEVELOPER", "type": "``\"developer\"``", "description": "The user is a developer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "MEMBER", "type": "``\"member\"``", "description": "The user is a team member.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "token", "type": "`string`", "description": "The token used to accept the invite.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "user_email", "type": "`string`", "description": "The email of the user being invited.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminNotesListRes **AdminNotesListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `notes`: [`Note`](../internal/classes/internal.Note.mdx)[] } The list of notes with pagination fields. ___ ### AdminNotesRes **AdminNotesRes**: `Object` The note's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "role", "type": "[`UserRoles`](../internal/enums/internal.internal.UserRoles.mdx)", "description": "The user's role. These roles don't provide any different privileges.", "optional": false, "defaultValue": "member", "expandable": false, "children": [ { "name": "ADMIN", "type": "``\"admin\"``", "description": "The user is an admin.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEVELOPER", "type": "``\"developer\"``", "description": "The user is a developer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "MEMBER", "type": "``\"member\"``", "description": "The user is a team member.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "author_id", "type": "`string`", "description": "The ID of the user that created the note.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The note's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Note refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Note refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`string`", "description": "The contents of the note.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminNotificationsListRes **AdminNotificationsListRes**: [`PaginatedResponse`](internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../internal/classes/internal.Notification.mdx)[] } ___ ### AdminNotificationsRes **AdminNotificationsRes**: `Object` The notification's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the notification provider as given by the notification service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the notification provider as given by the notification service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the notification provider as given by the notification service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "The ID of the customer that this notification was sent to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "event_name", "type": "`string`", "description": "The name of the event that the notification was sent for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The notification's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_id", "type": "`string`", "description": "The notification's parent ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_notification", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)", "description": "The details of the parent notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider", "type": "[`NotificationProvider`](../internal/classes/internal.NotificationProvider.mdx)", "description": "The notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the notification provider used to send the notification.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resends", "type": "[`Notification`](../internal/classes/internal.Notification.mdx)[]", "description": "The details of all resends of the notification.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "resource_id", "type": "`string`", "description": "The ID of the resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "resource_type", "type": "`string`", "description": "The type of resource that the Notification refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "to", "type": "`string`", "description": "The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminOrderEditItemChangeDeleteRes **AdminOrderEditItemChangeDeleteRes**: `Object` The details of deleting order edit item changes. #### Type declaration ___ ### AdminOrderEditsListRes **AdminOrderEditsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `order_edits`: [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[] } The list of order edits with pagination fields. ___ ### AdminOrderEditsRes **AdminOrderEditsRes**: `Object` The order edit details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "line_item_id", "type": "`string`", "description": "The ID of the cloned line item.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_edit", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit the item change is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit_id", "type": "`string`", "description": "The ID of the order edit", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_line_item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "original_line_item_id", "type": "`string`", "description": "The ID of the original line item in the order", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`OrderEditItemChangeType`](../internal/enums/internal.internal.OrderEditItemChangeType.mdx)", "description": "The order item change's status", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "ITEM_ADD", "type": "``\"item_add\"``", "description": "A new item to be added to the original order.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ITEM_REMOVE", "type": "``\"item_remove\"``", "description": "An existing item to be removed from the original order.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ITEM_UPDATE", "type": "``\"item_update\"``", "description": "An existing item to be updated in the original order.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "A discount can be applied to a cart for promotional purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "Amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "authorized_amount", "type": "``null`` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The ID of the user that created the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character ISO code for the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of the payment sessions created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PaymentCollectionStatus`](../internal/enums/internal.PaymentCollectionStatus.mdx)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "AUTHORIZED", "type": "``\"authorized\"``", "description": "The payment colleciton is authorized.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The payment collection is awaiting payment.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The payment collection is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The payment collection isn't paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_AUTHORIZED", "type": "``\"partially_authorized\"``", "description": "Some of the payments in the payment collection are authorized.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`ORDER_EDIT`](internal.mdx#order_edit)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order edit is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The order edit is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CREATED", "type": "``\"created\"``", "description": "The order edit is created.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DECLINED", "type": "``\"declined\"``", "description": "The order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUESTED", "type": "``\"requested\"``", "description": "The order edit is requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminOrdersListRes **AdminOrdersListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `orders`: [`Order`](../internal/classes/internal.Order.mdx)[] } The list of orders with pagination fields. ___ ### AdminOrdersRes **AdminOrdersRes**: `Object` The order's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [ { "name": "CLAIM", "type": "``\"claim\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEFAULT", "type": "``\"default\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT_ORDER", "type": "``\"draft_order\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PAYMENT_LINK", "type": "``\"payment_link\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SWAP", "type": "``\"swap\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim this item belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim this item is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "images", "type": "[`ClaimImage`](../internal/classes/internal.internal.ClaimImage.mdx)[]", "description": "The claim images that are attached to the claim item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the line item in the original order that this claim item refers to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item_id", "type": "`string`", "description": "The ID of the line item that the claim item refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note about the claim, for additional information", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "[`ClaimReason`](../internal/enums/internal.internal.ClaimReason.mdx)", "description": "The reason for the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tags", "type": "[`ClaimTag`](../internal/classes/internal.internal.ClaimTag.mdx)[]", "description": "User defined tags for easy filtering and grouping.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant to potentially replace the item in the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "`string`", "description": "The ID of the product variant that is claimed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The claim's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The claim's replacement items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The claim's replacement items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the claim's replacement items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the claim's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the claim's replacement items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The claim's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The claim's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The claim's replacement items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [ { "name": "NA", "type": "``\"na\"``", "description": "The payment status isn't set, which is typically used when the claim's type is `replace`.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_REFUNDED", "type": "``\"not_refunded\"``", "description": "The payment isn't refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The payment is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "REFUND", "type": "``\"refund\"``", "description": "The claim refunds an amount to the customer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REPLACE", "type": "``\"replace\"``", "description": "The claim replaces the returned item with a new one.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allocation", "type": "[`AllocationType`](../internal/enums/internal.internal.AllocationType.mdx)", "description": "The scope that the discount should apply to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "conditions", "type": "[`DiscountCondition`](../internal/classes/internal.DiscountCondition.mdx)[]", "description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "A short description of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount rule's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`DiscountRuleType`](../internal/enums/internal.internal.DiscountRuleType.mdx)", "description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the discount represents; this will depend on the type of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [ { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The draft order is completed, and an order has been created from it.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "OPEN", "type": "``\"open\"``", "description": "The draft order is open.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order item change's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "line_item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "line_item_id", "type": "`string`", "description": "The ID of the cloned line item.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_edit", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit the item change is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "`string`", "description": "The ID of the order edit", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_line_item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "original_line_item_id", "type": "`string`", "description": "The ID of the original line item in the order", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`OrderEditItemChangeType`](../internal/enums/internal.internal.OrderEditItemChangeType.mdx)", "description": "The order item change's status", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "Amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "authorized_amount", "type": "``null`` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The ID of the user that created the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character ISO code for the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of the payment sessions created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PaymentCollectionStatus`](../internal/enums/internal.PaymentCollectionStatus.mdx)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`ORDER_EDIT`](internal.mdx#order_edit)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order edit is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The order edit is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CREATED", "type": "``\"created\"``", "description": "The order edit is created.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DECLINED", "type": "``\"declined\"``", "description": "The order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUESTED", "type": "``\"requested\"``", "description": "The order edit is requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "fulfillment", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)", "description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)", "description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_number", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "url", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "A discount can be applied to a cart for promotional purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "display_name", "type": "`string`", "description": "The country name appropriate for display.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`number`", "description": "The country's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_2", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_3", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The normalized country name in upper case.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "num_code", "type": "`number`", "description": "The numerical ISO code for the country.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region the country is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the tax provider as given by the tax service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "A discount can be applied to a cart for promotional purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "is_requested", "type": "`boolean`", "description": "Whether the Return Item was requested initially or received unexpectedly in the warehouse.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the line item in the original order to be returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item_id", "type": "`string`", "description": "The ID of the Line Item that the Return Item references.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note with additional details about the Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the Line Item to be returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "[`ReturnReason`](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the reason for returning the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "reason_id", "type": "`string`", "description": "The ID of the reason for returning the item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_quantity", "type": "`number`", "description": "The quantity that was received in the warehouse.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_quantity", "type": "`number`", "description": "The quantity that was originally requested to be returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the Return that the Return Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "Details of the Return that the Return Item belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] } ] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The return is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RECEIVED", "type": "``\"received\"``", "description": "The return is received.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUESTED", "type": "``\"requested\"``", "description": "The return is requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The return is awaiting action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The Sales Channel Stock Location's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "location_id", "type": "`string`", "description": "The ID of the Location Stock.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel the location is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "`string`", "description": "The ID of the Sales Channel", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "admin_only", "type": "`boolean`", "description": "Flag to indicate if the Shipping Option usage is restricted to admin users.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "amount", "type": "``null`` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data needed for the Fulfillment Provider to identify the Shipping Option.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping option's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping option price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Flag to indicate if the Shipping Option can be used for Return shipments.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping Option - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_type", "type": "[`ShippingOptionPriceType`](../internal/enums/internal.internal.ShippingOptionPriceType.mdx)", "description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)", "description": "The details of the shipping profile that the shipping option belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "profile_id", "type": "`string`", "description": "The ID of the Shipping Profile that the shipping option belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this shipping option can be used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this shipping option can be used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requirements", "type": "[`ShippingOptionRequirement`](../internal/classes/internal.internal.ShippingOptionRequirement.mdx)[]", "description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The swap's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The swap's items aren't fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's fulfillments require an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The swap is additional awaiting payment.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's additional payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The swap's additional payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The swap's additional payment is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DIFFERENCE_REFUNDED", "type": "``\"difference_refunded\"``", "description": "The negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The swap's additional payment isn't paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The amount in the associated order has been refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's payment requires an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminPaymentCollectionDeleteRes **AdminPaymentCollectionDeleteRes**: `Object` The details of deleting a payment collection. #### Type declaration ___ ### AdminPaymentCollectionsRes **AdminPaymentCollectionsRes**: `Object` #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of the payment sessions created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "display_name", "type": "`string`", "description": "The country name appropriate for display.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`number`", "description": "The country's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_2", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_3", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The normalized country name in upper case.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "num_code", "type": "`number`", "description": "The numerical ISO code for the country.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region the country is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the tax provider as given by the tax service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PaymentCollectionStatus`](../internal/enums/internal.PaymentCollectionStatus.mdx)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "AUTHORIZED", "type": "``\"authorized\"``", "description": "The payment colleciton is authorized.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The payment collection is awaiting payment.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The payment collection is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The payment collection isn't paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_AUTHORIZED", "type": "``\"partially_authorized\"``", "description": "Some of the payments in the payment collection are authorized.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`ORDER_EDIT`](internal.mdx#order_edit)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminPaymentProvidersList **AdminPaymentProvidersList**: `Object` The list of payment providers in a store. #### Type declaration ___ ### AdminPaymentRes **AdminPaymentRes**: `Object` The payment's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [ { "name": "CLAIM", "type": "``\"claim\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEFAULT", "type": "``\"default\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT_ORDER", "type": "``\"draft_order\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PAYMENT_LINK", "type": "``\"payment_link\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SWAP", "type": "``\"swap\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The swap's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The swap's items aren't fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's fulfillments require an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The swap is additional awaiting payment.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's additional payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The swap's additional payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The swap's additional payment is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DIFFERENCE_REFUNDED", "type": "``\"difference_refunded\"``", "description": "The negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The swap's additional payment isn't paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The amount in the associated order has been refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's payment requires an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminPostDraftOrdersDraftOrderRegisterPaymentRes **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` The order's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment Session has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "``null`` \\| `string`", "description": "The ID of the cart that the payment session was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment session's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_initiated", "type": "`boolean`", "description": "A flag to indicate if a communication with the third party provider has been initiated.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_selected", "type": "``null`` \\| `boolean`", "description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the Payment Session was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Payment Provider that is responsible for the Payment Session", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "`string`", "description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [ { "name": "CLAIM", "type": "``\"claim\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DEFAULT", "type": "``\"default\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT_ORDER", "type": "``\"draft_order\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PAYMENT_LINK", "type": "``\"payment_link\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SWAP", "type": "``\"swap\"``", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim this item belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim this item is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "images", "type": "[`ClaimImage`](../internal/classes/internal.internal.ClaimImage.mdx)[]", "description": "The claim images that are attached to the claim item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the line item in the original order that this claim item refers to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item_id", "type": "`string`", "description": "The ID of the line item that the claim item refers to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note about the claim, for additional information", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "[`ClaimReason`](../internal/enums/internal.internal.ClaimReason.mdx)", "description": "The reason for the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tags", "type": "[`ClaimTag`](../internal/classes/internal.internal.ClaimTag.mdx)[]", "description": "User defined tags for easy filtering and grouping.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant to potentially replace the item in the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "`string`", "description": "The ID of the product variant that is claimed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The claim's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The claim's replacement items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The claim's replacement items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the claim's replacement items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the claim's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the claim's replacement items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The claim's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The claim's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The claim's replacement items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [ { "name": "NA", "type": "``\"na\"``", "description": "The payment status isn't set, which is typically used when the claim's type is `replace`.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_REFUNDED", "type": "``\"not_refunded\"``", "description": "The payment isn't refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The payment is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "REFUND", "type": "``\"refund\"``", "description": "The claim refunds an amount to the customer.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REPLACE", "type": "``\"replace\"``", "description": "The claim replaces the returned item with a new one.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "billing_address_id", "type": "``null`` \\| `string`", "description": "The customer's billing address ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "email", "type": "`string`", "description": "The customer's email", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "`string`", "description": "The customer's first name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The customer groups the customer belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customers", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)[]", "description": "The details of the customers that belong to the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "has_account", "type": "`boolean`", "description": "Whether the customer has an account or not", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "`string`", "description": "The customer's last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "A unique code for the discount - this will be used by the customer to apply the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The time at which the discount can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_dynamic", "type": "`boolean`", "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "parent_discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "The details of the parent discount that this discount was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "parent_discount_id", "type": "`string`", "description": "The Discount that the discount was created from. This will always be a dynamic discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "regions", "type": "[`Region`](../internal/classes/internal.Region.mdx)[]", "description": "The details of the regions in which the Discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule", "type": "[`DiscountRule`](../internal/classes/internal.internal.DiscountRule.mdx)", "description": "The details of the discount rule that defines how the discount will be applied to a cart..", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allocation", "type": "[`AllocationType`](../internal/enums/internal.internal.AllocationType.mdx)", "description": "The scope that the discount should apply to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "conditions", "type": "[`DiscountCondition`](../internal/classes/internal.DiscountCondition.mdx)[]", "description": "The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "A short description of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The discount rule's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`DiscountRuleType`](../internal/enums/internal.internal.DiscountRuleType.mdx)", "description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the discount represents; this will depend on the type of the discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "rule_id", "type": "`string`", "description": "The ID of the discount rule that defines how the discount will be applied to a cart.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "starts_at", "type": "`Date`", "description": "The time at which the discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "usage_count", "type": "`number`", "description": "The number of times a discount has been used.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "usage_limit", "type": "``null`` \\| `number`", "description": "The maximum number of times that a discount can be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "valid_duration", "type": "``null`` \\| `string`", "description": "Duration the discount runs between", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date the draft order was canceled at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the draft order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date the draft order was completed at.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The draft order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The draft order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification_order", "type": "`boolean`", "description": "Whether to send the customer notifications regarding order updates.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order created from the draft order when its payment is captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`DraftOrderStatus`](../internal/enums/internal.internal.DraftOrderStatus.mdx)", "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.", "optional": false, "defaultValue": "open", "expandable": false, "children": [ { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The draft order is completed, and an order has been created from it.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "OPEN", "type": "``\"open\"``", "description": "The draft order is open.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the edit was cancelled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_by", "type": "`string`", "description": "The unique identifier of the user or customer who cancelled the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "changes", "type": "[`OrderItemChange`](../internal/classes/internal.OrderItemChange.mdx)[]", "description": "The details of all the changes on the original order's line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order item change's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "line_item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "line_item_id", "type": "`string`", "description": "The ID of the cloned line item.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_edit", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit the item change is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "`string`", "description": "The ID of the order edit", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_line_item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "original_line_item_id", "type": "`string`", "description": "The ID of the original line item in the order", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`OrderEditItemChangeType`](../internal/enums/internal.internal.OrderEditItemChangeType.mdx)", "description": "The order item change's status", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the edit was confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_by", "type": "`string`", "description": "The unique identifier of the user or customer who confirmed the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The unique identifier of the user or customer who created the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_at", "type": "`Date`", "description": "The date with timezone at which the edit was declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_by", "type": "`string`", "description": "The unique identifier of the user or customer who declined the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "declined_reason", "type": "`string`", "description": "An optional note why the order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference between the total amount of the order and total amount of edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of the gift card tax amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of the gift card amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The order edit's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "internal_note", "type": "`string`", "description": "An optional note with additional details about the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this order edit was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that is edited", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_collection", "type": "[`PaymentCollection`](../internal/classes/internal.PaymentCollection.mdx)", "description": "The details of the payment collection used to authorize additional payment if necessary.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "Amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "authorized_amount", "type": "``null`` \\| `number`", "description": "Authorized amount of the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_by", "type": "`string`", "description": "The ID of the user that created the payment collection.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character ISO code for the currency this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "Description of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment collection's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of the payment sessions created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments created as part of the payment collection.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this payment collection is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PaymentCollectionStatus`](../internal/enums/internal.PaymentCollectionStatus.mdx)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`ORDER_EDIT`](internal.mdx#order_edit)", "description": "The type of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_collection_id", "type": "`string`", "description": "The ID of the payment collection", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_at", "type": "`Date`", "description": "The date with timezone at which the edit was requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_by", "type": "`string`", "description": "The unique identifier of the user or customer who requested the order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of the shipping amount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderEditStatus`](../internal/enums/internal.OrderEditStatus.mdx)", "description": "The status of the order edit.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order edit is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The order edit is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CREATED", "type": "``\"created\"``", "description": "The order edit is created.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DECLINED", "type": "``\"declined\"``", "description": "The order edit is declined.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUESTED", "type": "``\"requested\"``", "description": "The order edit is requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The total of subtotal", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the edited order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The order's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The order's items are not fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_FULFILLED", "type": "``\"partially_fulfilled\"``", "description": "Some of the order's items, but not all, are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_RETURNED", "type": "``\"partially_returned\"``", "description": "Some of the order's items, but not all, are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the order's items, but not all, are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's fulfillment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RETURNED", "type": "``\"returned\"``", "description": "The order's items are returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The order's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "fulfillment", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)", "description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)", "description": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_number", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "url", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that was used from the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)", "description": "The details of the gift card associated used in this transaction.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_card_id", "type": "`string`", "description": "The ID of the Gift Card that was used in the transaction.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card transaction's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_taxable", "type": "`boolean`", "description": "Whether the transaction is taxable or not.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was used for payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The tax rate of the transaction", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "balance", "type": "`number`", "description": "The remaining value on the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "code", "type": "`string`", "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "`Date`", "description": "The time at which the Gift Card can no longer be used.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The gift card's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the gift card was purchased in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this gift card is available in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The gift card's tax rate that will be applied on calculating totals", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "value", "type": "`number`", "description": "The value that the Gift Card represents.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "A discount can be applied to a cart for promotional purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The order's payment is awaiting capturing.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order's payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The order's payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The order's payment is not paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The order's payment amount is refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order's payment requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that has be refunded to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The refund's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the refund in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note explaining why the amount was refunded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order this refund was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the refund.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID, if available.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "`string`", "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "display_name", "type": "`string`", "description": "The country name appropriate for display.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`number`", "description": "The country's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_2", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "iso_3", "type": "`string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The normalized country name in upper case.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "num_code", "type": "`number`", "description": "The numerical ISO code for the country.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region the country is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "``null`` \\| `string`", "description": "The region ID this country is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the fulfillment provider as given by the fulfillment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the payment provider as given by the payment service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "id", "type": "`string`", "description": "The ID of the tax provider as given by the tax service.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_installed", "type": "`boolean`", "description": "Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] } ] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)", "description": "A discount can be applied to a cart for promotional purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "is_requested", "type": "`boolean`", "description": "Whether the Return Item was requested initially or received unexpectedly in the warehouse.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "item", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)", "description": "The details of the line item in the original order to be returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "item_id", "type": "`string`", "description": "The ID of the Line Item that the Return Item references.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "note", "type": "`string`", "description": "An optional note with additional details about the Return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the Line Item to be returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "reason", "type": "[`ReturnReason`](../internal/classes/internal.ReturnReason.mdx)", "description": "The details of the reason for returning the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "reason_id", "type": "`string`", "description": "The ID of the reason for returning the item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_quantity", "type": "`number`", "description": "The quantity that was received in the warehouse.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requested_quantity", "type": "`number`", "description": "The quantity that was originally requested to be returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the Return that the Return Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "Details of the Return that the Return Item belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] } ] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The return is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "RECEIVED", "type": "``\"received\"``", "description": "The return is received.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUESTED", "type": "``\"requested\"``", "description": "The return is requested.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The return is awaiting action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "The description of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The sales channel's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "is_disabled", "type": "`boolean`", "description": "Specify if the sales channel is enabled or disabled.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "locations", "type": "[`SalesChannelLocation`](../internal/classes/internal.internal.SalesChannelLocation.mdx)[]", "description": "The details of the stock locations related to the sales channel.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The Sales Channel Stock Location's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "location_id", "type": "`string`", "description": "The ID of the Location Stock.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel the location is associated with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "`string`", "description": "The ID of the Sales Channel", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the sales channel.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new items to be shipped when the claim's type is `replace`", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the claim was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](../internal/classes/internal.internal.ClaimItem.mdx)[]", "description": "The details of the items that should be replaced or refunded.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../internal/enums/internal.internal.ClaimFulfillmentStatus.mdx)", "description": "The claim's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The fulfillments of the new items to be shipped", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The claim's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that this claim was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the claim comes from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../internal/enums/internal.internal.ClaimPaymentStatus.mdx)", "description": "The status of the claim's payment", "optional": false, "defaultValue": "na", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that will be refunded in conjunction with the claim", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return associated with the claim if the claim's type is `replace`.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the address that new items should be shipped to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the address that the new items should be shipped to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods that the claim order will be shipped with.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "type", "type": "[`ClaimType`](../internal/enums/internal.internal.ClaimType.mdx)", "description": "The claim's type", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "admin_only", "type": "`boolean`", "description": "Flag to indicate if the Shipping Option usage is restricted to admin users.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "amount", "type": "``null`` \\| `number`", "description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data needed for the Fulfillment Provider to identify the Shipping Option.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping option's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping option price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Flag to indicate if the Shipping Option can be used for Return shipments.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name given to the Shipping Option - this may be displayed to the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_type", "type": "[`ShippingOptionPriceType`](../internal/enums/internal.internal.ShippingOptionPriceType.mdx)", "description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "profile", "type": "[`ShippingProfile`](../internal/classes/internal.ShippingProfile.mdx)", "description": "The details of the shipping profile that the shipping option belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "profile_id", "type": "`string`", "description": "The ID of the Shipping Profile that the shipping option belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this shipping option can be used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this shipping option can be used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "requirements", "type": "[`ShippingOptionRequirement`](../internal/classes/internal.internal.ShippingOptionRequirement.mdx)[]", "description": "The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "``null`` \\| `string`", "description": "A code to identify the tax type by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The tax line's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "A human friendly name for the tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "rate", "type": "`number`", "description": "The numeric rate to charge tax by", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [ { "name": "ARCHIVED", "type": "``\"archived\"``", "description": "The order is archived.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The order is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "COMPLETED", "type": "``\"completed\"``", "description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PENDING", "type": "``\"pending\"``", "description": "The order is pending.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The order requires action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "additional_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the new products to send to the customer, represented as line items.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "adjustments", "type": "[`LineItemAdjustment`](../internal/classes/internal.internal.LineItemAdjustment.mdx)[]", "description": "The details of the item's adjustments, which are available when a discount is applied on the item.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "Flag to indicate if the Line Item should be included when doing discount calculations.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the claim that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "A more detailed description of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been fulfilled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "The total of the gift card of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "Flag to indicate if the Line Item has fulfillment associated with it.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The line item's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Indicates if the line item unit_price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "Flag to indicate if the Line Item is a Gift Card.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "Is the item being returned", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)", "description": "The details of the order edit.", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "The ID of the order edit that the item may belong to.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the line item may belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "The original tax total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "The original total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "quantity", "type": "`number`", "description": "The quantity of the content in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "The total of discount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "The quantity of the Line Item that has been shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "The subtotal of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the line item may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](../internal/classes/internal.internal.LineItemTaxLine.mdx)[]", "description": "The details of the item's tax lines.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "A URL string to a small image of the contents of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "The title of the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "The total amount of the line item", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "unit_price", "type": "`number`", "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that this item was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "The id of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "allow_backorder", "type": "`boolean`", "description": "If true, swaps can be completed with items out of stock", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Swap was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The billing address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "completed_at", "type": "`Date`", "description": "The date with timezone at which the cart was completed.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "context", "type": "Record<`string`, `unknown`\\>", "description": "The context of the cart which can include info like IP or user agent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer the cart belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The customer's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "An array of details of all discounts applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the cart", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "An array of details of all gift cards applied to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The cart's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a cart in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The total of items with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The line items added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the payment associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_authorized_at", "type": "`Date`", "description": "The date with timezone at which the payment was authorized.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_id", "type": "`string`", "description": "The payment's ID if available", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_session", "type": "``null`` \\| [`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)", "description": "The details of the selected payment session in the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "payment_sessions", "type": "[`PaymentSession`](../internal/classes/internal.PaymentSession.mdx)[]", "description": "The details of all payment sessions created on the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order associated with this cart is returned.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The sales channel ID the cart is associated with.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "``null`` \\| [`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The shipping address's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods added to the cart.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The total of shipping with taxes", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the cart", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "type", "type": "[`CartType`](../internal/enums/internal.CartType.mdx)", "description": "The cart's type.", "optional": false, "defaultValue": "default", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the customer uses to complete the swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "confirmed_at", "type": "`Date`", "description": "The date with timezone at which the Swap was confirmed by the Customer.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "difference_due", "type": "`number`", "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`SwapFulfillmentStatus`](../internal/enums/internal.SwapFulfillmentStatus.mdx)", "description": "The status of the Fulfillment of the Swap.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's fulfillments are canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "FULFILLED", "type": "``\"fulfilled\"``", "description": "The swap's items are fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_FULFILLED", "type": "``\"not_fulfilled\"``", "description": "The swap's items aren't fulfilled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_SHIPPED", "type": "``\"partially_shipped\"``", "description": "Some of the swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's fulfillments require an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SHIPPED", "type": "``\"shipped\"``", "description": "The swap's items are shipped.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments that are used to send the new items to the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "canceled_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "The ID of the Claim that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The fulfillment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`FulfillmentItem`](../internal/classes/internal.internal.FulfillmentItem.mdx)[]", "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the fulfillment will be shipped from", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be sent.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the Order that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)", "description": "The details of the fulfillment provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipped_at", "type": "`Date`", "description": "The date with timezone at which the Fulfillment was shipped.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the fulfillment may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the Swap that the Fulfillment belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tracking_links", "type": "[`TrackingLink`](../internal/classes/internal.internal.TrackingLink.mdx)[]", "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tracking_numbers", "type": "`string`[]", "description": "The tracking numbers that can be used to track the status of the fulfillment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "id", "type": "`string`", "description": "The swap's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of the swap in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "If set to true, no notification will be sent related to this swap", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "billing_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the billing address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "billing_address_id", "type": "`string`", "description": "The ID of the billing address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "The date the order was canceled on.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claims", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)[]", "description": "The details of the claims created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that is used in the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "[`Customer`](../internal/classes/internal.Customer.mdx)", "description": "The details of the customer associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "customer_id", "type": "`string`", "description": "The ID of the customer associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discount_total", "type": "`number`", "description": "The total of discount rounded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "discounts", "type": "[`Discount`](../internal/classes/internal.Discount-1.mdx)[]", "description": "The details of the discounts applied on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "display_id", "type": "`number`", "description": "The order's display ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "draft_order", "type": "[`DraftOrder`](../internal/classes/internal.DraftOrder.mdx)", "description": "The details of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "draft_order_id", "type": "`string`", "description": "The ID of the draft order this order was created from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "edits", "type": "[`OrderEdit`](../internal/classes/internal.OrderEdit.mdx)[]", "description": "The details of the order edits done on the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "email", "type": "`string`", "description": "The email associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "external_id", "type": "``null`` \\| `string`", "description": "The ID of an external order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_status", "type": "[`FulfillmentStatus`](../internal/enums/internal.FulfillmentStatus.mdx)", "description": "The order's fulfillment status", "optional": false, "defaultValue": "not_fulfilled", "expandable": false, "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](../internal/classes/internal.Fulfillment.mdx)[]", "description": "The details of the fulfillments created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_card_tax_total", "type": "`number`", "description": "The total of gift cards with taxes", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_total", "type": "`number`", "description": "The total of gift cards", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "gift_card_transactions", "type": "[`GiftCardTransaction`](../internal/classes/internal.GiftCardTransaction.mdx)[]", "description": "The gift card transactions made in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards", "type": "[`GiftCard`](../internal/classes/internal.GiftCard-1.mdx)[]", "description": "The details of the gift card used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "id", "type": "`string`", "description": "The order's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the processing of the order in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "item_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on items", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that belong to the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "Flag for describing whether or not notifications related to this should be send.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "paid_total", "type": "`number`", "description": "The total amount paid", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_status", "type": "[`PaymentStatus`](../internal/enums/internal.PaymentStatus.mdx)", "description": "The order's payment status", "optional": false, "defaultValue": "not_paid", "expandable": false, "children": [] }, { "name": "payments", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)[]", "description": "The details of the payments used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "raw_discount_total", "type": "`number`", "description": "The total of discount", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refundable_amount", "type": "`number`", "description": "The amount that can be refunded", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunded_total", "type": "`number`", "description": "The total amount refunded if the order is returned.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refunds", "type": "[`Refund`](../internal/classes/internal.Refund.mdx)[]", "description": "The details of the refunds created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "region_id", "type": "`string`", "description": "The ID of the region this order was created in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "returnable_items", "type": "[`LineItem`](../internal/classes/internal.LineItem.mdx)[]", "description": "The details of the line items that are returnable as part of the order, swaps, or claims", "optional": true, "defaultValue": "", "expandable": true, "children": [] }, { "name": "returns", "type": "[`Return`](../internal/classes/internal.Return.mdx)[]", "description": "The details of the returns created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel", "type": "[`SalesChannel`](../internal/classes/internal.SalesChannel.mdx)", "description": "The details of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "sales_channel_id", "type": "``null`` \\| `string`", "description": "The ID of the sales channel this order belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address associated with the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "The ID of the shipping address associated with the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used in the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_tax_total", "type": "``null`` \\| `number`", "description": "The tax total applied on shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_total", "type": "`number`", "description": "The total of shipping", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`OrderStatus`](../internal/enums/internal.OrderStatus.mdx)", "description": "The order's status", "optional": false, "defaultValue": "pending", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swaps", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)[]", "description": "The details of the swaps created for the order.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the swap belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment", "type": "[`Payment`](../internal/classes/internal.Payment.mdx)", "description": "The details of the additional payment authorized by the customer when `difference_due` is positive.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount that the Payment has been authorized for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "amount_refunded", "type": "`number`", "description": "The amount of the original Payment amount that has been refunded back to the Customer.", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "canceled_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was canceled.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "captured_at", "type": "`string` \\| `Date`", "description": "The date with timezone at which the Payment was captured.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency of the payment.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character ISO currency code of the payment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The payment's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "Randomly generated key used to continue the completion of a payment in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the payment session was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "provider_id", "type": "`string`", "description": "The id of the Payment Provider that is responsible for the Payment", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that this payment was potentially created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "payment_status", "type": "[`SwapPaymentStatus`](../internal/enums/internal.SwapPaymentStatus.mdx)", "description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "AWAITING", "type": "``\"awaiting\"``", "description": "The swap is additional awaiting payment.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CANCELED", "type": "``\"canceled\"``", "description": "The swap's additional payment is canceled.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CAPTURED", "type": "``\"captured\"``", "description": "The swap's additional payment is captured.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "CONFIRMED", "type": "``\"confirmed\"``", "description": "The swap's additional payment is confirmed.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DIFFERENCE_REFUNDED", "type": "``\"difference_refunded\"``", "description": "The negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "NOT_PAID", "type": "``\"not_paid\"``", "description": "The swap's additional payment isn't paid.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "PARTIALLY_REFUNDED", "type": "``\"partially_refunded\"``", "description": "Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REFUNDED", "type": "``\"refunded\"``", "description": "The amount in the associated order has been refunded.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "REQUIRES_ACTION", "type": "``\"requires_action\"``", "description": "The swap's payment requires an action.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The return's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "idempotency_key", "type": "``null`` \\| `string`", "description": "Randomly generated key used to continue the completion of the return in case of failure.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "items", "type": "[`ReturnItem`](../internal/classes/internal.internal.ReturnItem.mdx)[]", "description": "The details of the items that the customer is returning.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "location_id", "type": "``null`` \\| `string`", "description": "The ID of the stock location the return will be added back.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "no_notification", "type": "``null`` \\| `boolean`", "description": "When set to true, no notification will be sent related to this return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "The ID of the order that the return was created for.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "received_at", "type": "`Date`", "description": "The date with timezone at which the return was received.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "The amount that should be refunded as a result of the return.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_data", "type": "Record<`string`, `unknown`\\>", "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_method", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)", "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "status", "type": "[`ReturnStatus`](../internal/enums/internal.internal.ReturnStatus.mdx)", "description": "Status of the Return.", "optional": false, "defaultValue": "requested", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "``null`` \\| `string`", "description": "The ID of the swap that the return may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address", "type": "[`Address`](../internal/classes/internal.Address.mdx)", "description": "The details of the shipping address that the new items should be sent to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "address_1", "type": "``null`` \\| `string`", "description": "Address line 1", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "address_2", "type": "``null`` \\| `string`", "description": "Address line 2", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "city", "type": "``null`` \\| `string`", "description": "City", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "company", "type": "``null`` \\| `string`", "description": "Company name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "country", "type": "``null`` \\| [`Country`](../internal/classes/internal.internal.Country.mdx)", "description": "A country object.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "country_code", "type": "``null`` \\| `string`", "description": "The 2 character ISO code of the country in lower case", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer", "type": "``null`` \\| [`Customer`](../internal/classes/internal.Customer.mdx)", "description": "Available if the relation `customer` is expanded.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_id", "type": "``null`` \\| `string`", "description": "ID of the customer this address belongs to", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "first_name", "type": "``null`` \\| `string`", "description": "First name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "ID of the address", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "last_name", "type": "``null`` \\| `string`", "description": "Last name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "phone", "type": "``null`` \\| `string`", "description": "Phone Number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "postal_code", "type": "``null`` \\| `string`", "description": "Postal Code", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "province", "type": "``null`` \\| `string`", "description": "Province", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "shipping_address_id", "type": "`string`", "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](../internal/classes/internal.ShippingMethod-4.mdx)[]", "description": "The details of the shipping methods used to fulfill the additional items purchased.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "cart", "type": "[`Cart`](../internal/classes/internal.Cart.mdx)", "description": "The details of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "cart_id", "type": "`string`", "description": "The ID of the cart that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](../internal/classes/internal.ClaimOrder.mdx)", "description": "The details of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "claim_order_id", "type": "``null`` \\| `string`", "description": "The ID of the claim that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "data", "type": "Record<`string`, `unknown`\\>", "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The shipping method's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the shipping method price include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "order", "type": "[`Order`](../internal/classes/internal.Order.mdx)", "description": "The details of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "order_id", "type": "`string`", "description": "The ID of the order that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price", "type": "`number`", "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_id", "type": "`string`", "description": "The ID of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "return_order", "type": "[`Return`](../internal/classes/internal.Return.mdx)", "description": "The details of the return that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option", "type": "[`ShippingOption`](../internal/classes/internal.ShippingOption.mdx)", "description": "The details of the shipping option the method was created from.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "shipping_option_id", "type": "`string`", "description": "The ID of the Shipping Option that the Shipping Method is built from.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "subtotal", "type": "`number`", "description": "The subtotal of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "swap", "type": "[`Swap`](../internal/classes/internal.Swap.mdx)", "description": "The details of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "swap_id", "type": "`string`", "description": "The ID of the swap that the shipping method is used in.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_lines", "type": "[`ShippingMethodTaxLine`](../internal/classes/internal.internal.ShippingMethodTaxLine.mdx)[]", "description": "The details of the tax lines applied on the shipping method.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_total", "type": "`number`", "description": "The total of tax", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the shipping", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "tax_rate", "type": "``null`` \\| `number`", "description": "The order's tax rate", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "The total of tax", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "total", "type": "`number`", "description": "The total amount of the order", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminPostInvitesPayload **AdminPostInvitesPayload**: [`Omit`](internal.mdx#omit)<[`AdminPostInvitesReq`](../internal/classes/internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal.mdx#inviteuserrolesenum) } ___ ### AdminPriceListDeleteBatchRes **AdminPriceListDeleteBatchRes**: `Object` The details of deleting a price list. #### Type declaration ___ ### AdminPriceListRes **AdminPriceListRes**: `Object` The price list's details. #### Type declaration ", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orders", "type": "[`Order`](../internal/classes/internal.Order.mdx)[]", "description": "The details of the orders this customer placed.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "phone", "type": "`string`", "description": "The customer's phone number", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "shipping_addresses", "type": "[`Address`](../internal/classes/internal.Address.mdx)[]", "description": "The details of the shipping addresses associated with the customer.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The customer group's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the customer group", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_lists", "type": "[`PriceList`](../internal/classes/internal.PriceList.mdx)[]", "description": "The price lists that are associated with the customer group.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "customer_groups", "type": "[`CustomerGroup`](../internal/classes/internal.CustomerGroup.mdx)[]", "description": "The details of the customer groups that the Price List can apply to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The price list's description", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The price list's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the price list prices include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The price list's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The prices that belong to the price list, represented as a Money Amount.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "starts_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PriceListStatus`](../internal/enums/internal.PriceListStatus.mdx)", "description": "The status of the Price List", "optional": false, "defaultValue": "draft", "expandable": false, "children": [] }, { "name": "type", "type": "[`PriceListType`](../internal/enums/internal.PriceListType.mdx)", "description": "The type of Price List. This can be one of either `sale` or `override`.", "optional": false, "defaultValue": "sale", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "description", "type": "`string`", "description": "The price list's description", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ends_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List stops being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The price list's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the price list prices include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The price list's name", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The prices that belong to the price list, represented as a Money Amount.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "amount", "type": "`number`", "description": "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency that the money amount may belong to.", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "code", "type": "`string`", "description": "The 3 character ISO code for the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the currency prices include tax", "optional": true, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "name", "type": "`string`", "description": "The written name of the currency", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol", "type": "`string`", "description": "The symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "symbol_native", "type": "`string`", "description": "The native symbol used to indicate the currency.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "currency_code", "type": "`string`", "description": "The 3 character currency code that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The money amount's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "max_quantity", "type": "``null`` \\| `number`", "description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "min_quantity", "type": "``null`` \\| `number`", "description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "price_list", "type": "``null`` \\| [`PriceList`](../internal/classes/internal.PriceList.mdx)", "description": "The details of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "price_list_id", "type": "``null`` \\| `string`", "description": "The ID of the price list that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "region", "type": "[`Region`](../internal/classes/internal.Region.mdx)", "description": "The details of the region that the money amount may belong to.", "optional": true, "defaultValue": "", "expandable": true, "children": [ { "name": "automatic_taxes", "type": "`boolean`", "description": "Whether taxes should be automated in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "countries", "type": "[`Country`](../internal/classes/internal.internal.Country.mdx)[]", "description": "The details of the countries included in this region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "currency", "type": "[`Currency`](../internal/classes/internal.Currency.mdx)", "description": "The details of the currency used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "currency_code", "type": "`string`", "description": "The three character currency code used in the region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "fulfillment_providers", "type": "[`FulfillmentProvider`](../internal/classes/internal.internal.FulfillmentProvider.mdx)[]", "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "gift_cards_taxable", "type": "`boolean`", "description": "Whether the gift cards are taxable or not in this region.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "Whether the prices for the region include tax", "optional": false, "defaultValue": "false", "expandable": false, "featureFlag": "tax_inclusive_pricing", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "name", "type": "`string`", "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "payment_providers", "type": "[`PaymentProvider`](../internal/classes/internal.PaymentProvider.mdx)[]", "description": "The details of the payment providers that can be used to process payments in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_code", "type": "`string`", "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_provider", "type": "[`TaxProvider`](../internal/classes/internal.TaxProvider.mdx)", "description": "The details of the tax provider used in the region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "tax_provider_id", "type": "``null`` \\| `string`", "description": "The ID of the tax provider used in this region", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rate", "type": "`number`", "description": "The tax rate that should be charged on purchases in the Region.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "tax_rates", "type": "``null`` \\| [`TaxRate`](../internal/classes/internal.TaxRate.mdx)[]", "description": "The details of the tax rates used in the region, aside from the default rate.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "region_id", "type": "`string`", "description": "The region's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)", "description": "The details of the product variant that the money amount may belong to.", "optional": false, "defaultValue": "", "expandable": true, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "variant_id", "type": "`string`", "description": "The ID of the Product Variant contained in the Line Item.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variants", "type": "[`ProductVariant`](../internal/classes/internal.internal.ProductVariant.mdx)[]", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [ { "name": "allow_backorder", "type": "`boolean`", "description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.", "optional": false, "defaultValue": "false", "expandable": false, "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "A generic field for a GTIN number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "created_at", "type": "`Date`", "description": "The date with timezone at which the resource was created.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "The date with timezone at which the resource was deleted.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "An EAN barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "The height of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "id", "type": "`string`", "description": "The product variant's ID", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](../internal/classes/internal.internal.ProductVariantInventoryItem.mdx)[]", "description": "The details inventory items of the product variant.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "The current quantity of the item that is stocked.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "The length of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "Whether Medusa should manage inventory for the Product Variant.", "optional": false, "defaultValue": "true", "expandable": false, "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "An optional key-value map with additional details", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](../internal/classes/internal.internal.ProductOptionValue.mdx)[]", "description": "The details of the product options that this product variant defines values for.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](../internal/classes/internal.internal.MoneyAmount.mdx)[]", "description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product", "type": "[`Product`](../internal/classes/internal.Product.mdx)", "description": "The details of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": true, "children": [] }, { "name": "product_id", "type": "`string`", "description": "The ID of the product that the product variant belongs to.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "title", "type": "`string`", "description": "A title that can be displayed for easy identification of the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "A UPC barcode number that can be used to identify the Product Variant.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "The ranking of this variant", "optional": false, "defaultValue": "0", "expandable": false, "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "The weight of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "The width of the Product Variant. May be used in shipping rate calculations.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ] }, { "name": "starts_at", "type": "``null`` \\| `Date`", "description": "The date with timezone that the Price List starts being valid.", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "status", "type": "[`PriceListStatus`](../internal/enums/internal.PriceListStatus.mdx)", "description": "The status of the Price List", "optional": false, "defaultValue": "draft", "expandable": false, "children": [ { "name": "ACTIVE", "type": "``\"active\"``", "description": "The price list is active, meaning its prices are applied to customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "DRAFT", "type": "``\"draft\"``", "description": "The price list is a draft, meaning its not yet applied to customers.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "type", "type": "[`PriceListType`](../internal/enums/internal.PriceListType.mdx)", "description": "The type of Price List. This can be one of either `sale` or `override`.", "optional": false, "defaultValue": "sale", "expandable": false, "children": [ { "name": "OVERRIDE", "type": "``\"override\"``", "description": "The price list is used to override original prices for specific conditions.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "SALE", "type": "``\"sale\"``", "description": "The price list is used for a sale.", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "The date with timezone at which the resource was updated.", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ] } ]} /> ___ ### AdminPriceListsListRes **AdminPriceListsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `price_lists`: [`PriceList`](../internal/classes/internal.PriceList.mdx)[] } The list of price lists with pagination fields. ___ ### AdminPriceListsProductsListRes **AdminPriceListsProductsListRes**: [`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `products`: [`Product`](../internal/classes/internal.Product.mdx)[] } The list of products with pagination fields. ___ ### AdminProductCategoriesCategoryRes **AdminProductCategoriesCategoryRes**: `Object` The product category's details. #### Type declaration