DiscountConditionMapTypeToProperty maps the discount condition type to its corresponding property.

@oas:schema:AdminPostInvitesInviteAcceptReq type: object description: "The details of the invite to be accepted." required: - token - user properties: token: description: "The token of the invite to accept.

@oas:schema:AdminPostOrderEditsEditLineItemsReq type: object description: "The details of the line item change to create." required: - variant_id - quantity properties: variant_id: description: The ID of the product variant associated with the item.

@oas:schema:AdminPostPriceListPricesPricesReq type: object description: "The details of the prices to add." properties: prices: description: The prices to update or add.

@oas:schema:AdminPostProductsToCollectionReq type: object description: "The details of the products to add to the collection." required: - product_ids properties: product_ids: description: "An array of Product IDs to add to the Product Collection." type: array items: description: "The ID of a Product to add to the Product Collection." type: string.

@oas:schema:AdminDeleteDiscountsDiscountConditionsConditionBatchReq type: object description: "The resources to remove." required: - resources properties: resources: description: The resources to be removed from the discount condition type: array items: type: object required: - id properties: id: description: The id of the item type: string.

@oas:schema:StorePostCustomersCustomerAddressesAddressReq anyOf: - $ref: "#/components/schemas/AddressPayload".

@oas:schema:StorePostCartsCartShippingMethodReq type: object description: "The details of the shipping method to add to the cart." required: - option_id properties: option_id: type: string description: ID of the shipping option to create the method from.

The context to apply on retrieved prices by a user admin.

@oas:schema:AdminPostDiscountsDiscountConditionsCondition type: object properties: products: type: array description: list of product IDs if the condition's type is `products`.

CalculationContextData represents the data required for performing calculations.

@oas:schema:StorePostCartsCartReq type: object description: "The details to update of the cart." properties: region_id: type: string description: "The ID of the Region to create the Cart in.

@oas:schema:PostAuthReq type: object description: The admin's credentials used to log in.

@oas:schema:AdminPostBatchesReq type: object description: The details of the batch job to create.

@oas:schema:StorePostCartReq type: object description: "The details of the cart to be created." properties: region_id: type: string description: "The ID of the Region to create the Cart in.

@oas:schema:AdminPostOrdersOrderClaimsReq type: object description: "The details of the claim to be created." required: - type - claim_items properties: type: description: >- The type of the Claim.

@oas:schema:AdminPostDiscountsDiscountConditions type: object required: - operator properties: operator: description: >- Operator of the condition.

@oas:schema:AdminPostCustomerGroupsReq type: object description: "The details of the customer group to create." required: - name properties: name: type: string description: Name of the customer group metadata: type: object description: Metadata of the customer group.

@oas:schema:PostCustomersReq type: object description: "The details of the customer to create." required: - email - first_name - last_name - password properties: email: type: string description: The customer's email.

@oas:schema:AdminPostDiscountsReq type: object description: "The details of the discount to create." required: - code - rule - regions properties: code: type: string description: A unique code that will be used to redeem the discount is_dynamic: type: boolean description: Whether the discount should have multiple instances of itself, each with a different code.

CreateDiscountRuleInput represents the input for creating a discount rule.

@oas:schema:AdminPostDiscountsDiscountDynamicCodesReq type: object description: "The details of the dynamic discount to create." required: - code properties: code: type: string description: A unique code that will be used to redeem the Discount usage_limit: type: number description: Maximum number of times the discount code can be used default: 1 metadata: type: object description: An optional set of key-value pairs to hold additional information.

@oas:schema:AdminPostGiftCardsReq type: object description: "The details of the gift card to create." required: - region_id properties: value: type: integer description: The value (excluding VAT) that the Gift Card should represent.

@oas:schema:AdminPostInvitesReq type: object required: - user - role properties: user: description: "The email associated with the invite.

@oas:schema:AdminPostNotesReq type: object description: "The details of the note to be created." required: - resource_id - resource_type - value properties: resource_id: type: string description: The ID of the resource which the Note relates to.

@oas:schema:AdminPostOrderEditsReq type: object description: "The details of the order edit to create." required: - order_id properties: order_id: description: The ID of the order to create the edit for.

@oas:schema:AdminPostOrdersOrderShipmentReq type: object description: "The details of the shipment to create." required: - fulfillment_id properties: fulfillment_id: description: The ID of the Fulfillment.

@oas:schema:AdminPostPriceListsPriceListReq type: object description: "The details of the price list to create." required: - name - description - type - prices properties: name: description: "The name of the Price List." type: string description: description: "The description of the Price List." type: string starts_at: description: "The date with timezone that the Price List starts being valid." type: string format: date ends_at: description: "The date with timezone that the Price List ends being valid." type: string format: date type: description: The type of the Price List.

@oas:schema:AdminPostProductCategoriesReq type: object description: "The details of the product category to create." required: - name properties: name: type: string description: The name of the product category description: type: string description: The description of the product category.

@oas:schema:AdminPostCollectionsReq type: object description: The product collection's details.

@oas:schema:AdminPostProductsReq type: object description: "The details of the product to create." required: - title properties: title: description: "The title of the Product" type: string subtitle: description: "The subtitle of the Product" type: string description: description: "The description of the Product." type: string is_giftcard: description: A flag to indicate if the Product represents a Gift Card.

@oas:schema:AdminPostProductsProductOptionsReq type: object description: "The details of the product option to create." required: - title properties: title: description: "The title the Product Option." type: string example: "Size".

@oas:schema:AdminPostProductsProductVariantsReq type: object description: "The details of the product variant to create." required: - title - prices - options properties: title: description: The title of the product variant.

@oas:schema:AdminPostPublishableApiKeysReq type: object description: "The details of the publishable API key to create." required: - title properties: title: description: The title of the publishable API key type: string.

@oas:schema:AdminPostRegionsReq type: object description: "The details of the region to create." required: - name - currency_code - tax_rate - payment_providers - fulfillment_providers - countries properties: name: description: "The name of the Region" type: string currency_code: description: "The 3 character ISO currency code to use in the Region." type: string externalDocs: url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes description: See a list of codes.

@oas:schema:StorePostReturnsReq type: object description: "The details of the return to create." required: - order_id - items properties: order_id: type: string description: The ID of the Order to create the return for.

@oas:schema:AdminPostReturnReasonsReq type: object description: "The details of the return reason to create." required: - label - value properties: label: description: "The label to display to the Customer." type: string value: description: "A unique value of the return reason." type: string parent_return_reason_id: description: "The ID of the parent return reason." type: string description: description: "The description of the Reason." type: string metadata: description: An optional set of key-value pairs with additional information.

@oas:schema:AdminPostSalesChannelsReq type: object description: "The details of the sales channel to create." required: - name properties: name: description: The name of the Sales Channel type: string description: description: The description of the Sales Channel type: string is_disabled: description: Whether the Sales Channel is disabled.

@oas:schema:AdminPostShippingOptionsReq type: object description: "The details of the shipping option to create." required: - name - region_id - provider_id - data - price_type properties: name: description: "The name of the Shipping Option" type: string region_id: description: "The ID of the Region in which the Shipping Option will be available." type: string provider_id: description: "The ID of the Fulfillment Provider that handles the Shipping Option." type: string profile_id: description: "The ID of the Shipping Profile to add the Shipping Option to." type: number data: description: "The data needed for the Fulfillment Provider to handle shipping with this Shipping Option." type: object price_type: description: >- The type of the Shipping Option price.

@oas:schema:AdminPostShippingProfilesReq type: object description: "The details of the shipping profile to create." required: - name - type properties: name: description: The name of the Shipping Profile type: string type: description: The type of the Shipping Profile type: string enum: [default, gift_card, custom] metadata: description: An optional set of key-value pairs with additional information.

@oas:schema:StorePostSwapsReq type: object description: "The details of the swap to create." required: - order_id - return_items - additional_items properties: order_id: type: string description: The ID of the Order to create the Swap for.

@oas:schema:AdminPostTaxRatesReq type: object description: "The details of the tax rate to create." required: - code - name - region_id properties: code: type: string description: "The code of the tax rate." name: type: string description: "The name of the tax rate." region_id: type: string description: "The ID of the Region that the tax rate belongs to." rate: type: number description: "The numeric rate to charge." products: type: array description: "The IDs of the products associated with this tax rate." items: type: string shipping_options: type: array description: "The IDs of the shipping options associated with this tax rate" items: type: string product_types: type: array description: "The IDs of the types of products associated with this tax rate" items: type: string.

@oas:schema:AdminCreateUserRequest type: object required: - email - password properties: email: description: "The User's email." type: string format: email first_name: description: "The first name of the User." type: string last_name: description: "The last name of the User." type: string role: description: "The role assigned to the user.

@oas:schema:StorePostCustomersCustomerAcceptClaimReq type: object description: "The details necessary to grant order access." required: - token properties: token: description: "The claim token generated by previous request to the Claim Order API Route." type: string.

@oas:schema:StorePostCustomersCustomerAddressesReq type: object required: - address properties: address: description: "The Address to add to the Customer's saved addresses." $ref: "#/components/schemas/AddressCreatePayload".

@oas:schema:StorePostCustomersCustomerOrderClaimReq type: object description: "The details of the orders to claim." required: - order_ids properties: order_ids: description: "The ID of the orders to claim" type: array items: type: string.

@oas:schema:AdminPostCustomerGroupsGroupCustomersBatchReq type: object description: "The customers to add to the customer group." required: - customer_ids properties: customer_ids: description: "The ids of the customers to add" type: array items: type: object required: - id properties: id: description: ID of the customer type: string.

@oas:schema:AdminDeletePriceListPricesPricesReq type: object description: "The details of the prices to delete." properties: price_ids: description: The IDs of the prices to delete.

@oas:schema:AdminDeletePriceListsPriceListProductsPricesBatchReq type: object description: "The details of the products' prices to delete." properties: product_ids: description: The IDs of the products to delete their associated prices.

DiscountAllocation represents the amount of a discount allocated to a line item.

DiscountConditionInput represents the input for a discount condition.

@oas:schema:AdminPostDraftOrdersReq type: object description: "The details of the draft order to create." required: - email - region_id - shipping_methods properties: status: description: >- The status of the draft order.

@oas:schema:AdminPostDraftOrdersDraftOrderReq type: object description: "The details of the draft order to update." properties: region_id: type: string description: The ID of the Region to create the Draft Order in.

AdminListCustomerSelector filters used to filter retrieved customers.

FilterableProductTaxRate represents the filters that can be applied when querying for shipping tax rates.

FindParams is used to configure how data is retrieved.

GiftCardAllocation represents the amount of a gift card allocated to a line item.

@oas:schema:AdminPostDraftOrdersDraftOrderLineItemsReq type: object description: "The details of the line item to create." required: - quantity properties: variant_id: description: The ID of the Product Variant associated with the line item.

LineAllocationsMap represents a map of line item ids and its corresponding gift card and discount allocations.

LineDiscount associates a line item and discount allocation.

LineDiscountAmount associates a line item and discount allocation.

@oas:schema:AdminPostProductsProductMetadataReq type: object required: - key - value properties: key: description: The metadata key type: string value: description: The metadata value type: string.

@oas:schema:AdminPostOrdersOrderClaimsClaimFulfillmentsReq type: object properties: metadata: description: An optional set of key-value pairs to hold additional information.

@oas:schema:AdminPostOrdersOrderClaimsClaimShipmentsReq type: object required: - fulfillment_id properties: fulfillment_id: description: The ID of the Fulfillment.

@oas:schema:StorePostOrderEditsOrderEditDecline type: object description: "The details of the order edit's decline." properties: declined_reason: type: string description: The reason for declining the Order Edit.

@oas:schema:AdminPostOrderEditsEditLineItemsLineItemReq type: object description: "The details to create or update of the line item change." required: - quantity properties: quantity: description: The quantity to update type: number.

@oas:schema:AdminPostOrdersOrderFulfillmentsReq type: object description: "The details of the fulfillment to be created." required: - items properties: items: description: The Line Items to include in the Fulfillment.

@oas:schema:AdminOrdersOrderLineItemReservationReq type: object required: - location_id properties: location_id: description: "The ID of the location of the reservation" type: string quantity: description: "The quantity to reserve" type: number.

@oas:schema:AdminPostOrdersOrderRefundsReq type: object description: "The details of the order refund." required: - amount - reason properties: amount: description: The amount to refund.

@oas:schema:AdminPostOrdersOrderReturnsReq type: object description: "The details of the requested return." required: - items properties: items: description: The line items that will be returned.

@oas:schema:AdminPostOrdersOrderShippingMethodsReq type: object description: "The shipping method's details." required: - price - option_id properties: price: type: number description: The price (excluding VAT) that should be charged for the Shipping Method option_id: type: string description: The ID of the Shipping Option to create the Shipping Method from.

@oas:schema:AdminPostOrdersOrderSwapsReq type: object description: "The details of the swap to create." required: - return_items properties: return_items: description: The Line Items to associate with the swap's return.

@oas:schema:StorePostPaymentCollectionsBatchSessionsAuthorizeReq type: object description: "The details of the payment sessions to authorize." required: - session_ids properties: session_ids: description: "List of Payment Session IDs to authorize." type: array items: type: string.

@oas:schema:StorePostPaymentCollectionsBatchSessionsReq type: object description: "The details of the payment sessions to manage." required: - sessions properties: sessions: description: "Payment sessions related to the Payment Collection.

@oas:schema:AdminPostPaymentRefundsReq type: object description: "The details of the refund to create." required: - amount - reason properties: amount: description: The amount to refund.

The context to apply on retrieved prices.

@oas:schema:StorePostSearchReq type: object properties: q: type: string description: The search query.

@oas:schema:AdminPostPublishableApiKeySalesChannelsBatchReq type: object description: "The details of the sales channels to add to the publishable API key." required: - sales_channel_ids properties: sales_channel_ids: description: The IDs of the sales channels to add to the publishable API key type: array items: type: object required: - id properties: id: type: string description: The ID of the sales channel.

@oas:schema:AdminPostRegionsRegionCountriesReq type: object description: "The details of the country to add to the region." required: - country_code properties: country_code: description: "The 2 character ISO code for the Country." type: string externalDocs: url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements description: See a list of codes.

@oas:schema:AdminPostRegionsRegionFulfillmentProvidersReq type: object description: "The details of the fulfillment provider to add to the region." required: - provider_id properties: provider_id: description: "The ID of the Fulfillment Provider." type: string.

@oas:schema:AdminPostRegionsRegionPaymentProvidersReq type: object description: "The details of the payment provider to add to the region." required: - provider_id properties: provider_id: description: "The ID of the Payment Provider." type: string.

@oas:schema:AdminPostNotificationsNotificationResendReq type: object description: "The resend details." properties: to: description: >- A new address or user identifier that the Notification should be sent to.

@oas:schema:AdminPostReturnsReturnReceiveReq type: object description: "The details of the received return." required: - items properties: items: description: The Line Items that have been received.

@oas:schema:AdminPostSalesChannelsChannelStockLocationsReq type: object required: - location_id properties: location_id: description: The ID of the stock location type: string.

@oas:schema:StorePostCartsCartPaymentSessionReq type: object description: "The details of the payment session to set." required: - provider_id properties: provider_id: type: string description: The ID of the Payment Provider.

SubtotalOptions represents options to use for subtotal calculations.

@oas:schema:AdminPostTaxRatesTaxRateProductsReq type: object description: "The details of the products to associat with the tax rate." required: - products properties: products: type: array description: "The IDs of the products to associate with this tax rate" items: type: string.

@oas:schema:AdminPostTaxRatesTaxRateProductTypesReq type: object description: "The product types to add to the tax rate." required: - product_types properties: product_types: type: array description: "The IDs of the types of products to associate with this tax rate" items: type: string.

@oas:schema:AdminPostTaxRatesTaxRateShippingOptionsReq type: object description: "The details of the shipping options to associate with the tax rate." required: - shipping_options properties: shipping_options: type: array description: "The IDs of the shipping options to associate with this tax rate" items: type: string.

@oas:schema:AdminPostOrdersOrderClaimsClaimReq type: object properties: claim_items: description: The Claim Items that the Claim will consist of.

@oas:schema:AdminPostCurrenciesCurrencyReq type: object description: "The details to update in the currency" properties: includes_tax: type: boolean x-featureFlag: "tax_inclusive_pricing" description: "Tax included in prices of currency.".

@oas:schema:AdminPostCustomerGroupsGroupReq type: object description: "The details to update in the customer group." properties: name: description: "Name of the customer group" type: string metadata: description: "Metadata of the customer group." type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute".

@oas:schema:PostCustomersCustomerReq type: object description: "The details of the customer to update." properties: email: type: string description: The Customer's email.

@oas:schema:AdminPostDiscountsDiscountReq type: object description: "The details of the discount to update." properties: code: type: string description: A unique code that will be used to redeem the discount rule: description: The discount rule that defines how discounts are calculated type: object required: - id properties: id: type: string description: "The ID of the Rule" description: type: string description: "A short description of the discount" value: type: number description: "The value that the discount represents.

UpdateDiscountRuleInput represents the input for updating a discount rule.

@oas:schema:AdminPostGiftCardsGiftCardReq type: object description: "The details to update of the gift card." properties: balance: type: integer description: The value (excluding VAT) that the Gift Card should represent.

@oas:schema:StorePostCartsCartLineItemsItemReq type: object description: "The details to update of the line item." required: - quantity properties: quantity: type: number description: The quantity of the line item in the cart.

@oas:schema:AdminPostNotesNoteReq type: object description: "The details to update of the note." required: - value properties: value: type: string description: The description of the Note.

@oas:schema:AdminPostOrderEditsOrderEditReq type: object description: "The details to update of the order edit." properties: internal_note: description: An optional note to create or update in the order edit.

@oas:schema:AdminPostOrdersOrderReq type: object description: "The details to update of the order." properties: email: description: The email associated with the order type: string billing_address: description: The order's billing address $ref: "#/components/schemas/AddressPayload" shipping_address: description: The order's shipping address $ref: "#/components/schemas/AddressPayload" items: description: The line items of the order type: array items: $ref: "#/components/schemas/LineItem" region: description: ID of the region that the order is associated with.

@oas:schema:AdminUpdatePaymentCollectionsReq type: object description: "The details to update of the payment collection." properties: description: description: A description to create or update the payment collection.

@oas:schema:StorePostCartsCartPaymentSessionUpdateReq type: object required: - data properties: data: type: object description: The data to update the payment session with.

@oas:schema:AdminPostPriceListsPriceListPriceListReq type: object description: "The details to update of the payment collection." properties: name: description: "The name of the Price List" type: string description: description: "The description of the Price List." type: string starts_at: description: "The date with timezone that the Price List starts being valid." type: string format: date ends_at: description: "The date with timezone that the Price List ends being valid." type: string format: date type: description: The type of the Price List.

@oas:schema:AdminPostProductCategoriesCategoryReq type: object description: "The details to update of the product category." properties: name: type: string description: The name to identify the Product Category by.

@oas:schema:AdminPostCollectionsCollectionReq type: object description: The product collection's details to update.

@oas:schema:AdminPostProductsProductReq type: object description: "The details to update of the product." properties: title: description: "The title of the Product" type: string subtitle: description: "The subtitle of the Product" type: string description: description: "The description of the Product." type: string discountable: description: A flag to indicate if discounts can be applied to the Line Items generated from this Product type: boolean images: description: An array of images of the Product.

@oas:schema:AdminPostProductsProductVariantsVariantReq type: object properties: title: description: The title of the product variant.

@oas:schema:AdminPostPublishableApiKeysPublishableApiKeyReq type: object description: "The details to update of the publishable API key." properties: title: description: The title of the Publishable API Key.

@oas:schema:AdminPostRegionsRegionReq type: object description: "The details to update of the regions." properties: name: description: "The name of the Region" type: string currency_code: description: "The 3 character ISO currency code to use in the Region." type: string externalDocs: url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes description: See a list of codes.

@oas:schema:AdminPostReturnReasonsReasonReq type: object description: "The details to update of the return reason." properties: label: description: "The label to display to the Customer." type: string value: description: "A unique value of the return reason." type: string description: description: "The description of the Reason." type: string metadata: description: An optional set of key-value pairs with additional information.

@oas:schema:AdminPostShippingOptionsOptionReq type: object description: "The details to update of the shipping option." required: - requirements properties: name: description: "The name of the Shipping Option" type: string amount: description: >- The amount to charge for the Shipping Option.

@oas:schema:AdminPostShippingProfilesProfileReq type: object description: "The detail to update of the shipping profile." properties: name: description: The name of the Shipping Profile type: string metadata: description: An optional set of key-value pairs with additional information.

@oas:schema:AdminPostStoreReq type: object description: "The details to update of the store." properties: name: description: "The name of the Store" type: string swap_link_template: description: >- A template for Swap links - use `{{cart_id}}` to insert the Swap Cart ID type: string example: "http://example.com/swaps/{{cart_id}}" payment_link_template: description: "A template for payment links - use `{{cart_id}}` to insert the Cart ID" example: "http://example.com/payments/{{cart_id}}" type: string invite_link_template: description: "A template for invite links - use `{{invite_token}}` to insert the invite token" example: "http://example.com/invite?token={{invite_token}}" type: string default_currency_code: description: "The default currency code of the Store." type: string externalDocs: url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes description: See a list of codes.

@oas:schema:AdminPostTaxRatesTaxRateReq type: object description: "The details to update of the tax rate." properties: code: type: string description: "The code of the tax rate." name: type: string description: "The name of the tax rate." region_id: type: string description: "The ID of the Region that the tax rate belongs to." rate: type: number description: "The numeric rate to charge." products: type: array description: "The IDs of the products associated with this tax rate" items: type: string shipping_options: type: array description: "The IDs of the shipping options associated with this tax rate" items: type: string product_types: type: array description: "The IDs of the types of product types associated with this tax rate" items: type: string.

@oas:schema:AdminUpdateUserRequest type: object properties: first_name: description: "The first name of the User." type: string last_name: description: "The last name of the User." type: string role: description: "The role assigned to the user.

@oas:schema:ResetPasswordRequest type: object description: "The details of the password reset request." required: - token - password properties: email: description: "The User's email." type: string format: email token: description: "The password-reset token generated when the password reset was requested." type: string password: description: "The User's new password." type: string format: password.

@oas:schema:ResetPasswordTokenRequest type: object description: "The details of the password reset token request." required: - email properties: email: description: "The User's email." type: string format: email.

LineAllocationsMap represents a map of line item ids and its corresponding gift card and discount allocations.

@oas:schema:AdminPostSalesChannelsSalesChannelReq type: object description: "The details to update of the sales channel." properties: name: type: string description: The name of the sales channel description: type: string description: The description of the sales channel.