@epcc-sdk/sdks-cart-checkout-order 0.0.7 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1465 -53
- package/dist/client/types.gen.cjs.map +1 -1
- package/dist/client/types.gen.d.cts +16 -0
- package/dist/client/types.gen.d.ts +16 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nexport type CartContact = {\n /**\n * The email address attached to a cart.\n */\n email?: string\n}\n\nexport type DiscountSettings = {\n /**\n * This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/settings/put-v-2-settings-cart).\n */\n custom_discounts_enabled?: boolean\n /**\n * When set to true, this parameter allows the cart to use rule promotions.\n */\n use_rule_promotions?: boolean\n}\n\nexport type InventorySettings = {\n /**\n * This parameter enables deferring inventory checks on the cart. This allows items to be added to or updating in the cart without checking stock levels. Inventory checks are still performed as normal on checkout\n */\n defer_inventory_check?: boolean\n}\n\n/**\n * Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.\n *\n * Example:\n * ```\n * \"custom_attributes\": {\n * \"is_member\": {\n * \"type\": \"boolean\",\n * \"value\": true\n * },\n * \"membership_level\": {\n * \"type\": \"string\",\n * \"value\": \"premium\"\n * }\n * }\n * ```\n *\n */\nexport type CustomAttributes = {\n [key: string]: unknown\n}\n\nexport type FormattedPriceData = {\n /**\n * The raw total.\n */\n amount?: number\n /**\n * The currency set for this amount.\n */\n currency?: string\n /**\n * The formatted total based on the amount and currency.\n */\n formatted?: string\n}\n\nexport type Timestamps = {\n /**\n * The date this was created.\n */\n created_at?: string\n /**\n * The date this was last updated.\n */\n updated_at?: unknown\n}\n\n/**\n * Relationship data entry\n */\nexport type RelationshipItem = {\n /**\n * The type of related resource.\n */\n type?: string\n /**\n * The ID of the related resource.\n */\n id?: string\n}\n\n/**\n * Array of relationships\n */\nexport type RelationshipArray = {\n /**\n * Individual relationships\n */\n data?: Array<RelationshipItem>\n}\n\nexport type CartResponse = {\n /**\n * The unique identifier for the cart. Use SDK or create it yourself.\n */\n id?: string\n /**\n * The type of object being returned.\n */\n type?: string\n /**\n * The name of this cart.\n */\n name?: string\n /**\n * A description of the cart.\n */\n description?: string\n contact?: CartContact\n discount_settings?: DiscountSettings\n inventory_settings?: InventorySettings\n /**\n * Stripe-assigned unique identifier for the linked Payment Intent\n */\n payment_intent_id?: string\n custom_attributes?: CustomAttributes\n links?: {\n /**\n * A link to that specific resource.\n */\n self?: string\n }\n meta?: {\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n without_discount?: FormattedPriceData\n shipping?: FormattedPriceData\n }\n timestamps?: Timestamps\n }\n relationships?: {\n customers?: RelationshipArray\n items?:\n | RelationshipArray\n | {\n data?: null\n }\n accounts?: RelationshipArray\n custom_discounts?: RelationshipArray\n promotions?: RelationshipArray\n }\n}\n\nexport type ResponsePageLinks = {\n /**\n * Always the current page.\n */\n current?: string\n /**\n * Always the first page.\n */\n first?: string\n /**\n * If there is only one page, it is `null`.\n */\n last?: string\n /**\n * If there is only one page, it is `null`.\n */\n next?: string\n /**\n * if the user is on the first page, it is `null`.\n */\n prev?: string\n}\n\nexport type ResponsePaginationPage = {\n /**\n * The current page.\n */\n current?: number\n /**\n * The maximum number of records per page for this response. You can set this value up to 100.\n */\n limit?: number\n /**\n * The current offset by number of records, not pages. Offset is zero-based.\n */\n offset?: number\n /**\n * The total page count.\n */\n total?: number\n}\n\nexport type ResponsePaginationResults = {\n /**\n * The total page count.\n */\n total?: number\n}\n\nexport type ResponseMetaCarts = {\n page?: ResponsePaginationPage\n results?: ResponsePaginationResults\n}\n\nexport type CartCollectionResponse = {\n data: Array<CartResponse>\n links?: ResponsePageLinks\n meta?: ResponseMetaCarts\n}\n\nexport type ResponseErrorItem = {\n /**\n * A brief summary of the error.\n */\n title: string\n /**\n * The HTTP response code of the error.\n */\n status: number\n /**\n * Optional additional detail about the error.\n */\n detail?: string\n meta?: {\n /**\n * The resource id associated with the error\n */\n id?: string\n ids?: Array<string>\n item_ids?: Array<string>\n /**\n * The shipping group id associated with the error\n */\n shipping_group_id?: string\n shipping_group_ids?: Array<string>\n /**\n * The cart id associated with the error\n */\n cart_id?: string\n /**\n * The code associated with the error.\n */\n code?: string\n /**\n * The order id associated with the error.\n */\n order_id?: string\n /**\n * The value associated with the error.\n */\n value?:\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n }\n}\n\nexport type ResponseErrorResponse = {\n errors: Array<ResponseErrorItem>\n}\n\nexport type CartsRequest = {\n data?: {\n /**\n * The cart description.\n */\n description?: string\n discount_settings?: DiscountSettings\n inventory_settings?: InventorySettings\n /**\n * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.\n */\n name?: string\n contact?: CartContact\n /**\n * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.\n */\n snapshot_date?: string\n /**\n * Specifies custom attributes for cart objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.\n *\n * Attribute types include:\n * - string\n * - boolean\n * - integer\n * - float\n *\n * Multiple custom attributes may be submitted together. A cart can have a maximum of 20 custom attributes.\n *\n * Example:\n * ```\n * \"custom_attributes\": {\n * \"is_member\": {\n * \"type\": \"boolean\",\n * \"value\": true\n * },\n * \"membership_level\": {\n * \"type\": \"string\",\n * \"value\": \"premium\"\n * }\n * }\n * ```\n *\n * Updating an existing cart with new custom attributes clears previously-saved attributes. In order to maintain existing custom attributes on a cart, please include them in the update request along with any new attributes.\n *\n */\n custom_attributes?: CustomAttributes\n /**\n * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.\n */\n payment_intent_id?: string\n }\n}\n\nexport type CartEntityResponse = {\n data: CartResponse\n}\n\n/**\n * The type of object being returned.\n */\nexport type Type = \"cart_item\"\n\nexport type CartItemObjectData = {\n /**\n * The type of object being returned.\n */\n type: \"cart_item\"\n /**\n * The number of items added to the cart.\n */\n quantity: number\n /**\n * Specifies the ID of the product you want to add to cart. (use this OR sku)\n */\n id?: string\n /**\n * Specifies the item SKU that you want to add to cart. (use this OR id)\n */\n sku?: string\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * Object used to describe the bundle options selected.\n */\n bundle_configuration?: {\n /**\n * Specifies selected options.\n */\n selected_options?: {\n [key: string]: unknown\n }\n /**\n * Array of component products for the selected options.\n */\n component_products?: Array<unknown>\n }\n /**\n * Identifier for a created Cart Shipping Group\n */\n shipping_group_id?: string\n /**\n * The slug of a stock location.\n */\n location?: string\n}\n\nexport type ItemPriceData = {\n /**\n * The amount for this item as an integer.\n */\n readonly amount?: number\n /**\n * The currency this item was added to the cart as.\n */\n readonly currency?: string\n /**\n * Whether or not this price is tax inclusive.\n */\n readonly includes_tax?: boolean\n}\n\nexport type CartItemFormattedPriceData = {\n /**\n * The amount per each single unit.\n */\n unit?: FormattedPriceData\n /**\n * The total amount of the item (i.e., unit * quantity).\n */\n value?: FormattedPriceData\n}\n\nexport type CartItemResponse = {\n /**\n * The unique ID of the product.\n */\n readonly product_id?: string\n /**\n * The unique ID of the subscription offering for subscription items.\n */\n readonly subscription_offering_id?: string\n /**\n * The name of this item\n */\n readonly name?: string\n /**\n * A description of the cart item.\n */\n readonly description?: string\n /**\n * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.\n */\n readonly catalog_id?: string\n /**\n * The catalog source. Always `pim` or `legacy`.\n */\n readonly catalog_source?: string\n readonly image?: {\n /**\n * The MIME type for the uploaded file.\n */\n readonly mime_type?: string\n /**\n * The name of the image file that was uploaded.\n */\n readonly file_name?: string\n /**\n * The link to the image.\n */\n readonly href?: string\n }\n /**\n * Whether or not the quantity of the item will be checked against inventory.\n */\n readonly manage_stock?: boolean\n /**\n * The unit price of the item.\n */\n unit_price?: ItemPriceData\n /**\n * The total price of the item (i.e., unit * quantity).\n */\n value?: ItemPriceData\n readonly links?: {\n /**\n * A URL related to the resource.\n */\n product?: string\n }\n readonly meta?: {\n display_price?: {\n /**\n * The amount of this item after discounts and taxes are applied.\n */\n with_tax?: CartItemFormattedPriceData\n /**\n * The amount of this item after discounts are applied and before taxes.\n */\n without_tax?: CartItemFormattedPriceData\n /**\n * The amount of taxes applied to this item.\n */\n tax?: CartItemFormattedPriceData\n /**\n * The amount of the discount applied to this item.\n */\n discount?: CartItemFormattedPriceData\n without_discount?: CartItemFormattedPriceData\n }\n timestamps?: Timestamps\n }\n}\n\nexport type CartItemObject = CartItemObjectData & CartItemResponse\n\nexport type CustomItemObjectData = {\n /**\n * The type of object being returned. Must be `custom_item`.\n */\n type: \"custom_item\"\n /**\n * The number of custom items to add to cart.\n */\n quantity: number\n price: {\n /**\n * The unit price of the custom item.\n */\n amount: number\n /**\n * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.\n */\n includes_tax?: boolean\n }\n /**\n * A description of the custom item.\n */\n description?: string\n /**\n * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.\n */\n sku?: string\n /**\n * The name of the custom item.\n */\n name: string\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * Identifier for a created Cart Shipping Group\n */\n shipping_group_id?: string\n}\n\nexport type CustomItemObject = {\n data?: CustomItemObjectData\n}\n\nexport type SubscriptionItemObjectData = {\n /**\n * The type of object being returned.\n */\n type: \"subscription_item\"\n /**\n * The number of items added to the cart.\n */\n quantity: number\n /**\n * Specifies the ID of the subscription offering you want to add to cart.\n */\n id: string\n /**\n * Specifies how the subscription offering should be configured.\n */\n subscription_configuration: {\n /**\n * The ID of the pricing option within the offering to use for the subscription.\n */\n pricing_option: string\n /**\n * The ID of the plan within the offering to use for the subscription.\n */\n plan: string\n }\n}\n\nexport type SubscriptionItemObject = {\n data?: SubscriptionItemObjectData & CartItemResponse\n}\n\nexport type PromotionItemObjectData = {\n /**\n * Specifies the type of resource, which is `promotion_item`.\n */\n type: \"promotion_item\"\n /**\n * Specifies the promotion code. For more information about codes[].user[], see the [Create Promotion codes](/docs/api/promotions/create-promotion-codes) section.\n */\n code: string\n}\n\nexport type PromotionItemObject = {\n data?: PromotionItemObjectData\n}\n\nexport type CartItemsResponse = {\n data?: Array<\n | CartItemObject\n | CustomItemObject\n | SubscriptionItemObject\n | PromotionItemObject\n >\n}\n\nexport type UpdateAllOrNothingOptionsObject = {\n /**\n * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.\n */\n update_all_or_nothing?: boolean\n}\n\nexport type BulkUpdateCartsItems = {\n data?: Array<{\n /**\n * Specifies the ID of the cart item that you want to update in cart.\n */\n id?: string\n /**\n * Specifies the amount of items to update in the cart.\n */\n quantity?: number\n /**\n * Specifies the custom text to be added to a product. See [custom inputs](https://elasticpath.dev/docs/pxm/products/ep-pxm-products-api/update-a-product#using-custom-inputs-attribute).\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n }>\n options?: UpdateAllOrNothingOptionsObject\n}\n\nexport type CartItemObjectRequest = {\n data?: CartItemObject\n}\n\nexport type CartMergeObject = {\n /**\n * The type of object being returned. Must be `cart_items`.\n */\n type: \"cart_items\"\n /**\n * The original cart to be merged from.\n */\n cart_id: string\n}\n\nexport type AddAllOrNothingOptionsObject = {\n /**\n * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.\n */\n add_all_or_nothing?: boolean\n}\n\nexport type CartMergeObjectRequest = {\n data?: CartMergeObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type ReOrderObject = {\n /**\n * The type of resource being returned. Use `order_items`.\n */\n type: \"order_items\"\n /**\n * The unique identifier of the order.\n */\n order_id: string\n}\n\nexport type ReOrderObjectRequest = {\n data?: ReOrderObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type BulkAddItemsRequest = {\n data?: Array<\n | CartItemObjectData\n | CartMergeObject\n | CustomItemObjectData\n | ReOrderObject\n | PromotionItemObjectData\n >\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartTimestamps = {\n created_at?: string\n updated_at?: unknown\n expires_at?: unknown\n}\n\nexport type CartsResponse = {\n data?: Array<\n | CartItemObject\n | CustomItemObject\n | SubscriptionItemObject\n | PromotionItemObject\n >\n meta?: {\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n without_discount?: FormattedPriceData\n discounts?: {\n [key: string]: {\n amount?: number\n currency?: string\n formatted?: string\n }\n }\n }\n timestamps?: CartTimestamps\n }\n}\n\nexport type UpdateCartsItems = {\n data?: {\n /**\n * The type of the cart item.\n */\n type?: \"cart_item\"\n /**\n * The unique identifier of the cart item.\n */\n id?: string\n /**\n * The amount of products to add to cart.\n */\n quantity?: number\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * The unique identifier of the shipping group to be added to the cart.\n */\n shipping_group_id?: string\n }\n}\n\nexport type CartsRelationshipsAccountsData = {\n data?: Array<{\n /**\n * The ID of the account.\n */\n id?: string\n /**\n * The type of related object. Ensure that it is account.\n */\n type?: string\n }>\n}\n\nexport type CartsRelationshipsCustomersData = {\n data?: Array<{\n /**\n * The ID of the customer.\n */\n id?: string\n /**\n * The type of related object. Ensure that it is customer.\n */\n type?: string\n }>\n}\n\nexport type CartsItemsTaxesObject = {\n /**\n * A unique tax code in this jurisdiction.\n */\n code?: string\n /**\n * The relevant tax jurisdiction.\n */\n jurisdiction?: string\n /**\n * The name of the tax item.\n */\n name?: string\n /**\n * The tax rate represented as a decimal (12.5% -> 0.125). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.\n */\n rate?: number\n /**\n * The tax rate represented as a number ($10 -> 1000). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.\n */\n amount?: number\n /**\n * The type of object being returned. Use `tax_item`.\n */\n type: string\n /**\n * The unique identifier for this tax item.\n */\n readonly id?: string\n}\n\nexport type CartItemTaxesEntityResponse = {\n data: CartsItemsTaxesObject\n}\n\nexport type CartItemRelationship = {\n relationships?: {\n order?: {\n data?: {\n /**\n * This specifies the type of item.\n */\n type?: string\n /**\n * This specifies the ID of the cart_item or custom_item in the cart.\n */\n id?: string\n }\n }\n }\n}\n\nexport type CartsBulkTaxes = {\n data?: Array<CartsItemsTaxesObject & CartItemRelationship>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsCustomDiscountsObject = {\n amount:\n | number\n | {\n amount?: number\n currency?: string\n formatted?: string\n }\n /**\n * Specifies a description for the custom discount.\n */\n description: string\n /**\n * Specifies the discount code used for the custom discount.\n */\n discount_code: string\n /**\n * Specifies from where the custom discount is applied. For example, Talon.one.\n */\n discount_engine: string\n /**\n * Specifies an external id for the custom discount.\n */\n external_id: string\n /**\n * Specifies the type of the resource. Always `custom_discount`.\n */\n type: string\n}\n\nexport type CustomDiscountRelationshipsCartItemRequest = {\n relationships?: {\n item?: {\n data?: {\n /**\n * Specifies the type of item. For example, `custom_item` or `cart_item`.\n */\n type?: string\n /**\n * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.\n */\n id?: string\n }\n }\n }\n}\n\nexport type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject &\n CustomDiscountRelationshipsCartItemRequest\n\nexport type CartsBulkCustomDiscounts = {\n data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsBulkCustomDiscountsResponse = {\n data?: CartsCustomDiscountsObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsBulkCustomDiscountsCollectionResponse = {\n data?: Array<CartsCustomDiscountsObject>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsCustomDiscountsResponseObject = {\n amount?: {\n /**\n * Specifies an amount to be applied for the custom discount. It must be less than zero.\n */\n amount?: number\n /**\n * The currency set for the custom discount.\n */\n currency?: string\n /**\n * The formatted value for the custom discount.\n */\n formatted?: string\n }\n /**\n * Specifies a description for the custom discount.\n */\n description?: string\n /**\n * Specifies the discount code used for the custom discount.\n */\n discount_code?: string\n /**\n * Specifies from where the custom discount is applied. For example, Talon.one.\n */\n discount_engine?: string\n /**\n * Specifies an external id for the custom discount.\n */\n external_id?: string\n /**\n * Specifies the type of the resource. Always `custom_discount`.\n */\n type?: string\n /**\n * Specifies the UUID of the custom discount.\n */\n readonly id?: string\n}\n\nexport type CartsCustomDiscountsEntityRequest = {\n data?: CartsCustomDiscountsResponseObject\n}\n\nexport type CartsCustomDiscountsEntityResponse = {\n data?: CartsCustomDiscountsObject\n}\n\nexport type CartsCustomDiscountsCollectionResponse = {\n data?: Array<CartsCustomDiscountsObject>\n}\n\nexport type ShippingAddress = {\n /**\n * First name of the shipping recipient.\n */\n first_name: string\n /**\n * Last name of the shipping recipient.\n */\n last_name: string\n /**\n * Phone number of the shipping recipient.\n */\n phone_number: string\n /**\n * Company of the shipping recipient.\n */\n company_name: string\n /**\n * First line of the shipping address.\n */\n line_1: string\n /**\n * Second line of the shipping address.\n */\n line_2: string\n /**\n * City of the shipping address.\n */\n city: string\n /**\n * Post code of the shipping address.\n */\n postcode: string\n /**\n * County of the shipping address.\n */\n county: string\n /**\n * Country of the shipping address.\n */\n country: string\n /**\n * State, province, or region of the shipping address.\n */\n region?: string\n /**\n * Delivery instructions.\n */\n instructions: string\n}\n\nexport type DeliveryEstimate = {\n start?: Date\n end?: Date\n}\n\nexport type Money = {\n /**\n * Amount in minor currency units (e.g., cents).\n */\n amount: number\n /**\n * ISO 4217 currency code (e.g., \"USD\").\n */\n currency: string\n /**\n * Whether the amount includes tax.\n */\n includes_tax: boolean\n}\n\nexport type Discount = {\n amount: Money\n /**\n * The discount code used, if applicable.\n */\n code?: string\n /**\n * Unique identifier for the discount.\n */\n id: string\n /**\n * The source or origin of the promotion, if applicable.\n */\n promotion_source?: string\n /**\n * Indicates whether the discount applies to the entire cart.\n */\n is_cart_discount?: boolean\n /**\n * Order in which the discount was applied.\n */\n ordinal?: number\n}\n\nexport type Discounts = Array<Discount>\n\nexport type ShippingPriceResponse = {\n total: FormattedPriceData\n base: FormattedPriceData\n tax?: FormattedPriceData\n fees?: FormattedPriceData\n discount?: FormattedPriceData\n}\n\nexport type OrderPriceWrapperMeta = {\n with_tax: FormattedPriceData\n without_tax: FormattedPriceData\n tax: FormattedPriceData\n discount: FormattedPriceData\n balance_owing: FormattedPriceData\n paid: FormattedPriceData\n authorized: FormattedPriceData\n without_discount: FormattedPriceData\n shipping: FormattedPriceData\n shipping_discount: FormattedPriceData\n}\n\nexport type ShippingGroupMeta = {\n shipping_display_price?: ShippingPriceResponse\n total_display_price?: OrderPriceWrapperMeta\n}\n\nexport type ShippingGroupResponse = {\n type?: \"shipping_group\"\n id?: string\n relation?: string\n cart_id?: string\n order_id?: string\n shipping_type?: string\n tracking_reference?: string\n address?: ShippingAddress\n delivery_estimate?: DeliveryEstimate\n createdAt?: Date\n updatedAt?: Date\n relationships?: {\n cart?: RelationshipItem\n order?: RelationshipItem\n }\n discounts?: Discounts\n meta?: ShippingGroupMeta\n}\n\nexport type ShippingPriceRequest = {\n total?: number\n base?: number\n tax?: number\n fees?: number\n discount?: number\n}\n\nexport type CreateShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n shipping_price?: ShippingPriceRequest\n address?: ShippingAddress\n includes_tax?: boolean\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type UpdateCartShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n shipping_price?: ShippingPriceRequest\n address?: ShippingAddress\n includes_tax?: boolean\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type Gateway =\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n\n/**\n * Specifies the transaction method, such as `purchase` or `authorize`.\n */\nexport type Method =\n | \"authorize\"\n | \"purchase\"\n | \"purchase_setup\"\n | \"authorize_setup\"\n\nexport type DataBasePayments = {\n gateway:\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n /**\n * Specifies the transaction method, such as `purchase` or `authorize`.\n */\n method: \"authorize\" | \"purchase\" | \"purchase_setup\" | \"authorize_setup\"\n /**\n * The amount to be paid for the transaction.\n */\n amount?: number\n}\n\nexport type ElasticPathPaymentsPoweredByStripePayment = {\n data?: DataBasePayments & {\n /**\n * Specifies the gateway. You must use `elastic_path_payments_stripe`.\n */\n gateway?: \"elastic_path_payments_stripe\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n /**\n * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.\n */\n automatic_payment_methods?: {\n /**\n * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.\n */\n enabled?: boolean\n }\n }\n /**\n * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).\n */\n payment_method_types?: Array<string>\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n }\n}\n\nexport type CartPaymentUpdate = {\n data: {\n gateway: string\n method: string\n payment_method_types: Array<string>\n amount: number\n options?: {\n [key: string]: unknown\n }\n }\n}\n\nexport type BillingAddress = {\n /**\n * First name of the billing recipient.\n */\n first_name: string\n /**\n * Last name of the billing recipient.\n */\n last_name: string\n /**\n * Company name of the billing recipient.\n */\n company_name: string\n /**\n * First line of the billing address.\n */\n line_1: string\n /**\n * Second line of the billing address.\n */\n line_2: string\n /**\n * City of the billing address.\n */\n city: string\n /**\n * Postcode of the billing address.\n */\n postcode: string\n /**\n * County of the billing address.\n */\n county: string\n /**\n * Country of the billing address.\n */\n country: string\n /**\n * State, province, or region of the billing address.\n */\n region?: string\n}\n\nexport type CustomerCheckout = {\n data?: {\n /**\n * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n customer?: {\n /**\n * The ID of the customer.\n */\n id?: string\n /**\n * The email of the customer.\n */\n email?: string\n /**\n * The name of the customer.\n */\n name?: string\n }\n billing_address?: BillingAddress\n shipping_address?: ShippingAddress\n }\n}\n\nexport type AccountCheckout = {\n data?: {\n /**\n * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n account?: {\n /**\n * The account ID.\n */\n id?: string\n /**\n * The account member ID.\n */\n member_id?: string\n }\n contact?: {\n /**\n * The name of the account member.\n */\n name?: string\n /**\n * The email address of the account member.\n */\n email?: string\n }\n billing_address?: BillingAddress\n shipping_address?: ShippingAddress\n }\n}\n\nexport type OrderMeta = {\n timestamps?: Timestamps\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n balance_owing?: FormattedPriceData\n paid?: FormattedPriceData\n authorized?: FormattedPriceData\n without_discount?: FormattedPriceData\n shipping?: FormattedPriceData\n shipping_discount?: FormattedPriceData\n }\n}\n\nexport type Contact = {\n /**\n * The email address of the contact.\n */\n email?: string\n /**\n * The name of the contact.\n */\n name?: string\n}\n\n/**\n * Single relationship\n */\nexport type SingleRelationship = {\n data?: RelationshipItem\n}\n\n/**\n * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.\n */\nexport type Status = \"complete\" | \"incomplete\" | \"cancelled\" | \"processing\"\n\n/**\n * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.\n */\nexport type Payment =\n | \"authorized\"\n | \"paid\"\n | \"unpaid\"\n | \"refunded\"\n | \"partially_paid\"\n | \"partially_authorized\"\n\n/**\n * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.\n */\nexport type Shipping = \"unfulfilled\" | \"fulfilled\"\n\nexport type OrderResponse = {\n /**\n * Specifies the type of object being returned. You must use `order`.\n */\n type?: \"order\"\n /**\n * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n /**\n * Specifies the unique identifier of the order.\n */\n readonly id?: string\n /**\n * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.\n */\n status?: \"complete\" | \"incomplete\" | \"cancelled\" | \"processing\"\n /**\n * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.\n */\n payment?:\n | \"authorized\"\n | \"paid\"\n | \"unpaid\"\n | \"refunded\"\n | \"partially_paid\"\n | \"partially_authorized\"\n /**\n * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.\n */\n shipping?: \"unfulfilled\" | \"fulfilled\"\n /**\n * Specifies if the order is anonymized.\n */\n anonymized?: boolean\n /**\n * Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.\n */\n payment_intent_id?: string\n custom_attributes?: CustomAttributes\n meta?: OrderMeta\n billing_address?: BillingAddress\n contact?: Contact\n customer?: Contact\n shipping_address?: ShippingAddress\n relationships?: {\n items?: RelationshipArray\n custom_discounts?: RelationshipArray\n promotions?: RelationshipArray\n customer?: SingleRelationship\n account?: SingleRelationship\n account_member?: SingleRelationship\n }\n}\n\nexport type OrderEntityResponse = {\n data?: OrderResponse\n}\n\nexport type ResponseMetaOrders = {\n page?: ResponsePaginationPage\n results?: ResponsePaginationResults\n}\n\nexport type OrderCollectionResponse = {\n data?: Array<OrderResponse>\n links?: ResponsePageLinks\n meta?: ResponseMetaOrders\n}\n\nexport type OrdersAddressData = {\n /**\n * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n shipping_address: {\n /**\n * Specifies the first name of the address holder.\n */\n first_name?: string\n /**\n * Specifies the last name of the address holder.\n */\n last_name?: string\n /**\n * Specifies the phone number of the address holder.\n */\n phone_number?: string\n /**\n * Specifies the company name.\n */\n company_name?: string\n /**\n * Specifies the first line of the address.\n */\n line_1?: string\n /**\n * Specifies the second line of the address.\n */\n line_2?: string\n /**\n * Specifies the name of the city in the shipping address.\n */\n city?: string\n /**\n * Specifies the county of the shipping address.\n */\n county?: string\n /**\n * Specifies the state, province, or region of the shipping address.\n */\n region?: string\n /**\n * Specifies the postcode or ZIP code of the address.\n */\n postcode?: string\n /**\n * Specifies the country in the shipping address.\n */\n country?: string\n /**\n * Specifies any instructions provided with the shipping address.\n */\n instructions?: string\n }\n}\n\nexport type OrdersCancelData = {\n /**\n * The status of the order. You can only update the status to `cancelled`.\n */\n status: string\n /**\n * The type of the resource. You must use order.\n */\n type: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n}\n\nexport type OrdersFulfilledData = {\n /**\n * The shipping status of the order. You can only update the shipping status to `fulfilled`.\n */\n shipping: string\n /**\n * The type of the resource. You must use order.\n */\n type: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n}\n\nexport type OrdersUpdateRequest = {\n data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData\n}\n\nexport type OrderPriceData = {\n /**\n * The amount for this item.\n */\n amount?: number\n /**\n * The currency this item.\n */\n currency?: string\n /**\n * Whether this price is tax inclusive.\n */\n includes_tax?: boolean\n}\n\nexport type DiscountData = {\n amount?: OrderPriceData\n code?: string\n readonly id?: string\n}\n\nexport type OrderItemFormattedUnitPriceData = {\n unit?: FormattedPriceData\n value?: FormattedPriceData\n}\n\nexport type OrderItemResponse = {\n /**\n * The type represents the object being returned.\n */\n type?: string\n /**\n * The unique identifier for this order item.\n */\n readonly id?: string\n /**\n * The quantity of this item were ordered.\n */\n quantity?: number\n /**\n * The unique identifier for this order item.\n */\n readonly product_id?: string\n /**\n * The unique identifier for the subscription offering for this order item.\n */\n readonly subscription_offering_id?: string\n /**\n * The name of this order item.\n */\n name?: string\n /**\n * The SKU code for the order item.\n */\n sku?: string\n unit_price?: OrderPriceData\n value?: OrderPriceData\n discounts?: Array<DiscountData>\n links?: {\n [key: string]: unknown\n }\n meta?: {\n display_price?: {\n with_tax?: OrderItemFormattedUnitPriceData\n without_tax?: OrderItemFormattedUnitPriceData\n tax?: OrderItemFormattedUnitPriceData\n discount?: OrderItemFormattedUnitPriceData\n without_discount?: OrderItemFormattedUnitPriceData\n discounts?: {\n [key: string]: {\n amount?: number\n currency?: string\n formatted?: string\n }\n }\n }\n timestamps?: Timestamps\n }\n relationships?: {\n cart_item?: {\n data?: {\n /**\n * The type represents the object being returned.\n */\n type?: string\n /**\n * The unique identifier for this item.\n */\n readonly id?: string\n }\n }\n }\n /**\n * The unique identifier of the catalog associated with the product is shown if `catalog_source=pim` is set.\n */\n catalog_id?: string\n /**\n * The catalog source. Always `pim` or `legacy`.\n */\n catalog_source?: string\n}\n\nexport type OrderItemCollectionResponse = {\n data?: Array<OrderItemResponse>\n}\n\nexport type OrdersAnonymizeData = {\n /**\n * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.\n */\n order_ids?: Array<string>\n}\n\nexport type OrdersAnonymizeRequest = {\n data?: OrdersAnonymizeData\n}\n\nexport type OrdersListResponse = {\n data: Array<OrderResponse>\n}\n\nexport type DataAdyenPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `adyen`.\n */\n gateway: \"adyen\"\n options?: {\n /**\n * The shopper reference token associated with the saved payment method.\n */\n shopper_reference?: string\n /**\n * Enter CardOnFile for a one-time purchase.\n */\n recurring_processing_model?: string\n }\n /**\n * The Adyen recurringDetailReference payment method identifier.\n */\n payment: string\n}\n\nexport type DataAuthorizeNetPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `authorize_net`.\n */\n gateway: \"authorize_net\"\n options?: {\n /**\n * The Authorize.net customer payment profile ID.\n */\n customer_payment_profile_id?: string\n }\n /**\n * The Authorize.net customer profile ID.\n */\n payment: string\n}\n\nexport type DataBraintreePayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `braintree`.\n */\n gateway: \"braintree\"\n /**\n * The Braintree Customer ID that you want to bill.\n */\n payment: string\n}\n\nexport type DataCardConnectPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `card_connect`.\n */\n gateway: \"card_connect\"\n /**\n * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.\n */\n payment: string\n}\n\nexport type DataCyberSourcePayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `cyber_source`.\n */\n gateway: \"cyber_source\"\n /**\n * The CyberSource token.\n */\n payment: string\n}\n\nexport type DataManualPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `manual`.\n */\n gateway: \"manual\"\n paymentmethod_meta?: {\n /**\n * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.\n */\n custom_reference?: string\n /**\n * A custom name associated with the payment method.\n */\n name?: string\n }\n}\n\nexport type DataPayPalExpressCheckoutPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `paypal_express_checkout`.\n */\n gateway: \"paypal_express_checkout\"\n options?: {\n /**\n * The description for the payment.\n */\n description?: string\n /**\n * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.\n */\n soft_descriptor?: string\n application_context?: {\n /**\n * The label that overrides the business name in the PayPal account on the PayPal site.\n */\n brand_name?: string\n /**\n * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.\n */\n locale?: string\n /**\n * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.\n */\n landing_page?: string\n /**\n * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.\n */\n shipping_preference?: string\n /**\n * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.\n */\n user_action?: string\n /**\n * The callback URL for PayPal to redirect the user in the case of approved payment.\n */\n return_url?: string\n /**\n * The callback URL for PayPal to redirect user in the case a cancelled payment.\n */\n cancel_url?: string\n }\n }\n}\n\nexport type DataStripePayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe`.\n */\n gateway: \"stripe\"\n options?: {\n /**\n * The option to provide an email for Stripe receipts. Specify live mode to access this feature.\n */\n receipt_email?: string\n }\n /**\n * The Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataStripeConnectPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe_connect`.\n */\n gateway: \"stripe_connect\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n }\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataStripePaymentIntentsPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe_payment_intents`.\n */\n gateway: \"stripe_payment_intents\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n }\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataPaymentObject =\n | DataAdyenPayment\n | DataAuthorizeNetPayment\n | DataBraintreePayment\n | DataCardConnectPayment\n | DataCyberSourcePayment\n | ElasticPathPaymentsPoweredByStripePayment\n | DataManualPayment\n | DataPayPalExpressCheckoutPayment\n | DataStripePayment\n | DataStripeConnectPayment\n | DataStripePaymentIntentsPayment\n\nexport type PaymentsRequest = {\n data?: DataPaymentObject\n}\n\nexport type TransactionResponse = {\n /**\n * The ID of the transaction.\n */\n readonly id?: string\n /**\n * The payment gateway reference.\n */\n reference?: string\n /**\n * A custom name associated with the payment method.\n */\n name?: string\n /**\n * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.\n */\n custom_reference?: string\n /**\n * The name of the payment gateway used.\n */\n gateway?:\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n | \"stripe_platform_account\"\n /**\n * The amount for this transaction.\n */\n amount?: number\n /**\n * The refunded amount.\n */\n refunded_amount?: number\n /**\n * The transaction currency.\n */\n currency?: string\n /**\n * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.\n */\n \"transaction-type\"?: string\n /**\n * The status provided by the gateway for this transaction, such as `complete` or `failed`.\n */\n status?: string\n relationships?: {\n order?: {\n data?: {\n /**\n * Represents the type of the object being returned. It is always `order`.\n */\n type?: string\n /**\n * The ID of the order.\n */\n id?: string\n }\n }\n }\n meta?: {\n display_price?: FormattedPriceData\n display_refunded_amount?: FormattedPriceData\n timestamps?: Timestamps\n }\n}\n\nexport type TransactionEntityResponse = {\n data: TransactionResponse\n}\n\nexport type OrdersTransactionsConfirmRequest = {\n data?: {\n [key: string]: unknown\n }\n}\n\nexport type OrdersTransactionsCaptureRequest = {\n data?: {\n options?: {\n soft_descriptor?: string\n note_to_payer?: string\n }\n }\n}\n\nexport type OrdersTransactionsRefundRequest = {\n data?: {\n /**\n * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.\n */\n amount?: number\n options?: {\n /**\n * Provides comments about the refund. It is used by PayPal Express.\n */\n note?: string\n }\n }\n}\n\nexport type TransactionListResponse = {\n data: Array<TransactionResponse>\n}\n\nexport type ResponseData = {\n data?: unknown\n}\n\nexport type OrdersTransactionsCancelRequest = {\n data?: {\n options?: {\n [key: string]: unknown\n }\n /**\n * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.\n */\n reason?: string\n }\n}\n\nexport type UpdateOrderShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n address?: ShippingAddress\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type GetCartsData = {\n body?: never\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/carts\"\n}\n\nexport type GetCartsErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n title?: string\n }>\n }\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n}\n\nexport type GetCartsError = GetCartsErrors[keyof GetCartsErrors]\n\nexport type GetCartsResponses = {\n 200: CartCollectionResponse\n}\n\nexport type GetCartsResponse = GetCartsResponses[keyof GetCartsResponses]\n\nexport type CreateACartData = {\n body?: CartsRequest\n headers?: {\n /**\n * A customer token to be associated with the cart.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/carts\"\n}\n\nexport type CreateACartErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n}\n\nexport type CreateACartError = CreateACartErrors[keyof CreateACartErrors]\n\nexport type CreateACartResponses = {\n 201: CartEntityResponse\n}\n\nexport type CreateACartResponse =\n CreateACartResponses[keyof CreateACartResponses]\n\nexport type DeleteACartData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart that you want to delete.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type DeleteACartErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type DeleteACartError = DeleteACartErrors[keyof DeleteACartErrors]\n\nexport type DeleteACartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteACartResponse =\n DeleteACartResponses[keyof DeleteACartResponses]\n\nexport type GetACartData = {\n body?: never\n path: {\n /**\n * The unique identifier for this cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type GetACartErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n}\n\nexport type GetACartError = GetACartErrors[keyof GetACartErrors]\n\nexport type GetACartResponses = {\n /**\n * OK\n */\n 200: CartEntityResponse\n}\n\nexport type GetACartResponse = GetACartResponses[keyof GetACartResponses]\n\nexport type UpdateACartData = {\n body?: CartsRequest\n path: {\n /**\n * The unique identifier of a cart created by you.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type UpdateACartErrors = {\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n /**\n * Unprocessable Content\n */\n 422: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n}\n\nexport type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors]\n\nexport type UpdateACartResponses = {\n 200: CartEntityResponse\n}\n\nexport type UpdateACartResponse =\n UpdateACartResponses[keyof UpdateACartResponses]\n\nexport type DeleteAllCartItemsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart created by you.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type DeleteAllCartItemsErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type DeleteAllCartItemsError =\n DeleteAllCartItemsErrors[keyof DeleteAllCartItemsErrors]\n\nexport type DeleteAllCartItemsResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAllCartItemsResponse =\n DeleteAllCartItemsResponses[keyof DeleteAllCartItemsResponses]\n\nexport type GetCartItemsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type GetCartItemsResponses = {\n 200: CartItemsResponse\n}\n\nexport type GetCartItemsResponse =\n GetCartItemsResponses[keyof GetCartItemsResponses]\n\nexport type ManageCartsData = {\n body?:\n | CartItemObjectRequest\n | SubscriptionItemObject\n | CartMergeObjectRequest\n | CustomItemObject\n | ReOrderObjectRequest\n | PromotionItemObject\n | BulkAddItemsRequest\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type ManageCartsErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n /**\n * Internal Server Error\n */\n 500: ResponseErrorResponse\n}\n\nexport type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors]\n\nexport type ManageCartsResponses = {\n 201: CartsResponse\n}\n\nexport type ManageCartsResponse =\n ManageCartsResponses[keyof ManageCartsResponses]\n\nexport type BulkUpdateItemsInCartData = {\n body?: BulkUpdateCartsItems\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type BulkUpdateItemsInCartErrors = {\n /**\n * Insufficient Stock\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkUpdateItemsInCartError =\n BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors]\n\nexport type BulkUpdateItemsInCartResponses = {\n 200: unknown\n}\n\nexport type DeleteACartItemData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart created by you.\n */\n cartID: string\n /**\n * The unique identifier of the cart that you want to delete.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}\"\n}\n\nexport type DeleteACartItemResponses = {\n 200: CartsResponse\n}\n\nexport type DeleteACartItemResponse =\n DeleteACartItemResponses[keyof DeleteACartItemResponses]\n\nexport type UpdateACartItemData = {\n body?: UpdateCartsItems\n path: {\n /**\n * A unique identifier of the cart that you created.\n */\n cartID: string\n /**\n * A unique identifier of the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}\"\n}\n\nexport type UpdateACartItemErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n}\n\nexport type UpdateACartItemError =\n UpdateACartItemErrors[keyof UpdateACartItemErrors]\n\nexport type UpdateACartItemResponses = {\n 200: CartsResponse\n}\n\nexport type UpdateACartItemResponse =\n UpdateACartItemResponses[keyof UpdateACartItemResponses]\n\nexport type DeleteAccountCartAssociationData = {\n body?: CartsRelationshipsAccountsData\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the account.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/accounts\"\n}\n\nexport type DeleteAccountCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n}\n\nexport type DeleteAccountCartAssociationError =\n DeleteAccountCartAssociationErrors[keyof DeleteAccountCartAssociationErrors]\n\nexport type DeleteAccountCartAssociationResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAccountCartAssociationResponse =\n DeleteAccountCartAssociationResponses[keyof DeleteAccountCartAssociationResponses]\n\nexport type CreateAccountCartAssociationData = {\n body?: CartsRelationshipsAccountsData\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/accounts\"\n}\n\nexport type CreateAccountCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateAccountCartAssociationError =\n CreateAccountCartAssociationErrors[keyof CreateAccountCartAssociationErrors]\n\nexport type CreateAccountCartAssociationResponses = {\n /**\n * OK\n */\n 200: CartsRelationshipsAccountsData\n /**\n * No Content is sent back in case the account has already been associated to the cart.\n */\n 204: void\n}\n\nexport type CreateAccountCartAssociationResponse =\n CreateAccountCartAssociationResponses[keyof CreateAccountCartAssociationResponses]\n\nexport type DeleteCustomerCartAssociationData = {\n body?: CartsRelationshipsCustomersData\n headers?: {\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the customer.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/customers\"\n}\n\nexport type DeleteCustomerCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n}\n\nexport type DeleteCustomerCartAssociationError =\n DeleteCustomerCartAssociationErrors[keyof DeleteCustomerCartAssociationErrors]\n\nexport type DeleteCustomerCartAssociationResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomerCartAssociationResponse =\n DeleteCustomerCartAssociationResponses[keyof DeleteCustomerCartAssociationResponses]\n\nexport type CreateCustomerCartAssociationData = {\n body?: CartsRelationshipsCustomersData\n headers?: {\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/customers\"\n}\n\nexport type CreateCustomerCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n /**\n * Unauthorized\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateCustomerCartAssociationError =\n CreateCustomerCartAssociationErrors[keyof CreateCustomerCartAssociationErrors]\n\nexport type CreateCustomerCartAssociationResponses = {\n /**\n * OK\n */\n 200: CartsRelationshipsCustomersData\n /**\n * No Content\n */\n 204: void\n}\n\nexport type CreateCustomerCartAssociationResponse =\n CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses]\n\nexport type DeleteAPromotionViaPromotionCodeData = {\n body?: never\n path: {\n /**\n * Specifies the unique identifier of a cart created by you.\n */\n cartID: string\n /**\n * Specifies the promotion code to be deleted.\n */\n promoCode: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/discounts/{promoCode}\"\n}\n\nexport type DeleteAPromotionViaPromotionCodeResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAPromotionViaPromotionCodeResponse =\n DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses]\n\nexport type AddTaxItemToCartData = {\n body?: CartItemTaxesEntityResponse\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes\"\n}\n\nexport type AddTaxItemToCartErrors = {\n /**\n * Unauthorized\n */\n 422: ResponseErrorResponse\n}\n\nexport type AddTaxItemToCartError =\n AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors]\n\nexport type AddTaxItemToCartResponses = {\n 200: CartItemTaxesEntityResponse\n /**\n * Created\n */\n 201: CartItemTaxesEntityResponse\n}\n\nexport type AddTaxItemToCartResponse =\n AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses]\n\nexport type BulkDeleteTaxItemsFromCartData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/taxes\"\n}\n\nexport type BulkDeleteTaxItemsFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type BulkDeleteTaxItemsFromCartResponse =\n BulkDeleteTaxItemsFromCartResponses[keyof BulkDeleteTaxItemsFromCartResponses]\n\nexport type BulkAddTaxItemsToCartData = {\n body?: CartsBulkTaxes\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/taxes\"\n}\n\nexport type BulkAddTaxItemsToCartErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkAddTaxItemsToCartError =\n BulkAddTaxItemsToCartErrors[keyof BulkAddTaxItemsToCartErrors]\n\nexport type BulkAddTaxItemsToCartResponses = {\n 200: CartsBulkTaxes\n /**\n * Created\n */\n 201: CartsBulkTaxes\n}\n\nexport type BulkAddTaxItemsToCartResponse =\n BulkAddTaxItemsToCartResponses[keyof BulkAddTaxItemsToCartResponses]\n\nexport type DeleteATaxItemData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n /**\n * The unique identifier of the tax item.\n */\n taxitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}\"\n}\n\nexport type DeleteATaxItemResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteATaxItemResponse =\n DeleteATaxItemResponses[keyof DeleteATaxItemResponses]\n\nexport type UpdateATaxItemData = {\n body?: CartItemTaxesEntityResponse\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n /**\n * The unique identifier of the tax item.\n */\n taxitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}\"\n}\n\nexport type UpdateATaxItemResponses = {\n 200: CartItemTaxesEntityResponse\n}\n\nexport type UpdateATaxItemResponse =\n UpdateATaxItemResponses[keyof UpdateATaxItemResponses]\n\nexport type BulkDeleteCustomDiscountsFromCartData = {\n body?: never\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts\"\n}\n\nexport type BulkDeleteCustomDiscountsFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type BulkDeleteCustomDiscountsFromCartResponse =\n BulkDeleteCustomDiscountsFromCartResponses[keyof BulkDeleteCustomDiscountsFromCartResponses]\n\nexport type BulkAddCustomDiscountsToCartData = {\n body?: CartsBulkCustomDiscounts\n path: {\n /**\n * Specifies the system generated ID for the cart that the shopper created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts\"\n}\n\nexport type BulkAddCustomDiscountsToCartErrors = {\n /**\n * Could not apply custom discount\n */\n 400: ResponseErrorResponse\n /**\n * Could not apply custom discount\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkAddCustomDiscountsToCartError =\n BulkAddCustomDiscountsToCartErrors[keyof BulkAddCustomDiscountsToCartErrors]\n\nexport type BulkAddCustomDiscountsToCartResponses = {\n 201:\n | CartsBulkCustomDiscountsResponse\n | CartsBulkCustomDiscountsCollectionResponse\n}\n\nexport type BulkAddCustomDiscountsToCartResponse =\n BulkAddCustomDiscountsToCartResponses[keyof BulkAddCustomDiscountsToCartResponses]\n\nexport type DeleteCustomDiscountFromCartData = {\n body?: never\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the custom discount to be deleted.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type DeleteCustomDiscountFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomDiscountFromCartResponse =\n DeleteCustomDiscountFromCartResponses[keyof DeleteCustomDiscountFromCartResponses]\n\nexport type UpdateCustomDiscountForCartData = {\n body?: CartsCustomDiscountsEntityRequest\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the custom discount to be updated.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type UpdateCustomDiscountForCartResponses = {\n 200: CartsCustomDiscountsEntityResponse\n}\n\nexport type UpdateCustomDiscountForCartResponse =\n UpdateCustomDiscountForCartResponses[keyof UpdateCustomDiscountForCartResponses]\n\nexport type AddCustomDiscountToCartItemData = {\n body?: CartsCustomDiscountsObject\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the unique identifier for the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts\"\n}\n\nexport type AddCustomDiscountToCartItemErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Bad Request\n */\n 422: ResponseErrorResponse\n}\n\nexport type AddCustomDiscountToCartItemError =\n AddCustomDiscountToCartItemErrors[keyof AddCustomDiscountToCartItemErrors]\n\nexport type AddCustomDiscountToCartItemResponses = {\n /**\n * Successful request\n */\n 201:\n | CartsCustomDiscountsCollectionResponse\n | CartsCustomDiscountsEntityResponse\n}\n\nexport type AddCustomDiscountToCartItemResponse =\n AddCustomDiscountToCartItemResponses[keyof AddCustomDiscountToCartItemResponses]\n\nexport type DeleteCustomDiscountFromCartItemData = {\n body?: never\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the cart item.\n */\n cartitemID: string\n /**\n * Specifies the ID for the custom discount to be deleted.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type DeleteCustomDiscountFromCartItemResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomDiscountFromCartItemResponse =\n DeleteCustomDiscountFromCartItemResponses[keyof DeleteCustomDiscountFromCartItemResponses]\n\nexport type UpdateCustomDiscountForCartItemData = {\n body?: CartsCustomDiscountsEntityRequest\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the cart item.\n */\n cartitemID: string\n /**\n * Specifies the ID for the custom discount to be updated.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type UpdateCustomDiscountForCartItemResponses = {\n 200: CartsCustomDiscountsEntityResponse\n}\n\nexport type UpdateCustomDiscountForCartItemResponse =\n UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses]\n\nexport type GetShippingGroupsData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/shipping-groups\"\n}\n\nexport type GetShippingGroupsErrors = {\n /**\n * Cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupsError =\n GetShippingGroupsErrors[keyof GetShippingGroupsErrors]\n\nexport type GetShippingGroupsResponses = {\n /**\n * A list of shipping groups\n */\n 200: {\n data?: Array<ShippingGroupResponse>\n }\n}\n\nexport type GetShippingGroupsResponse =\n GetShippingGroupsResponses[keyof GetShippingGroupsResponses]\n\nexport type CreateShippingGroupData = {\n body: CreateShippingGroupRequest\n path: {\n /**\n * The ID of the cart\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/shipping-groups\"\n}\n\nexport type CreateShippingGroupErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type CreateShippingGroupError =\n CreateShippingGroupErrors[keyof CreateShippingGroupErrors]\n\nexport type CreateShippingGroupResponses = {\n /**\n * Shipping group created successfully\n */\n 201: ShippingGroupResponse\n}\n\nexport type CreateShippingGroupResponse =\n CreateShippingGroupResponses[keyof CreateShippingGroupResponses]\n\nexport type DeleteCartShippingGroupData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group to delete\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type DeleteCartShippingGroupErrors = {\n /**\n * Cannot delete shipping group that is attached to cart items\n */\n 400: ResponseErrorResponse\n /**\n * Cart or shipping group not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type DeleteCartShippingGroupError =\n DeleteCartShippingGroupErrors[keyof DeleteCartShippingGroupErrors]\n\nexport type DeleteCartShippingGroupResponses = {\n /**\n * Successfully deleted the shipping group\n */\n 204: void\n}\n\nexport type DeleteCartShippingGroupResponse =\n DeleteCartShippingGroupResponses[keyof DeleteCartShippingGroupResponses]\n\nexport type GetShippingGroupByIdData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type GetShippingGroupByIdErrors = {\n /**\n * Shipping group or cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupByIdError =\n GetShippingGroupByIdErrors[keyof GetShippingGroupByIdErrors]\n\nexport type GetShippingGroupByIdResponses = {\n /**\n * Shipping group details\n */\n 200: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type GetShippingGroupByIdResponse =\n GetShippingGroupByIdResponses[keyof GetShippingGroupByIdResponses]\n\nexport type UpdateShippingGroupData = {\n body: UpdateCartShippingGroupRequest\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type UpdateShippingGroupErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Shipping group or cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type UpdateShippingGroupError =\n UpdateShippingGroupErrors[keyof UpdateShippingGroupErrors]\n\nexport type UpdateShippingGroupResponses = {\n /**\n * Shipping group updated successfully\n */\n 200: ShippingGroupResponse\n}\n\nexport type UpdateShippingGroupResponse =\n UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses]\n\nexport type CreateCartPaymentIntentData = {\n body?: ElasticPathPaymentsPoweredByStripePayment\n path: {\n /**\n * The universally unique identifier of the cart for which you want to create a payment intent.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/payments\"\n}\n\nexport type CreateCartPaymentIntentResponses = {\n /**\n * Payment Intent created successfully.\n */\n 201: CartResponse\n}\n\nexport type CreateCartPaymentIntentResponse =\n CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses]\n\nexport type UpdateCartPaymentIntentData = {\n body: CartPaymentUpdate\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the payment intent.\n */\n paymentIntentID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/payments/{paymentIntentID}\"\n}\n\nexport type UpdateCartPaymentIntentResponses = {\n /**\n * Payment updated successfully\n */\n 200: CartResponse\n}\n\nexport type UpdateCartPaymentIntentResponse =\n UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses]\n\nexport type CheckoutApiData = {\n body?: CustomerCheckout | AccountCheckout\n headers?: {\n /**\n * An account management authentication token that identifies the authenticated account member.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID of the cart that you want to checkout.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/checkout\"\n}\n\nexport type CheckoutApiErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Internal Server Error\n */\n 500: ResponseErrorResponse\n}\n\nexport type CheckoutApiError = CheckoutApiErrors[keyof CheckoutApiErrors]\n\nexport type CheckoutApiResponses = {\n /**\n * OK\n */\n 201: OrderEntityResponse\n}\n\nexport type CheckoutApiResponse =\n CheckoutApiResponses[keyof CheckoutApiResponses]\n\nexport type GetCustomerOrdersData = {\n body?: never\n headers?: {\n /**\n * A customer token to access a specific customer's orders.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/orders\"\n}\n\nexport type GetCustomerOrdersResponses = {\n 200: OrderCollectionResponse\n}\n\nexport type GetCustomerOrdersResponse =\n GetCustomerOrdersResponses[keyof GetCustomerOrdersResponses]\n\nexport type GetAnOrderData = {\n body?: never\n path: {\n /**\n * The ID of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}\"\n}\n\nexport type GetAnOrderErrors = {\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetAnOrderError = GetAnOrderErrors[keyof GetAnOrderErrors]\n\nexport type GetAnOrderResponses = {\n /**\n * OK\n */\n 200: OrderEntityResponse\n}\n\nexport type GetAnOrderResponse = GetAnOrderResponses[keyof GetAnOrderResponses]\n\nexport type UpdateAnOrderData = {\n body?: OrdersUpdateRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}\"\n}\n\nexport type UpdateAnOrderErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type UpdateAnOrderError = UpdateAnOrderErrors[keyof UpdateAnOrderErrors]\n\nexport type UpdateAnOrderResponses = {\n /**\n * OK\n */\n 200: OrderEntityResponse\n}\n\nexport type UpdateAnOrderResponse =\n UpdateAnOrderResponses[keyof UpdateAnOrderResponses]\n\nexport type GetOrderItemsData = {\n body?: never\n path: {\n /**\n * The ID of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/items\"\n}\n\nexport type GetOrderItemsResponses = {\n 200: OrderItemCollectionResponse\n}\n\nexport type GetOrderItemsResponse =\n GetOrderItemsResponses[keyof GetOrderItemsResponses]\n\nexport type AnonymizeOrdersData = {\n body?: OrdersAnonymizeRequest & unknown\n path?: never\n query?: never\n url: \"/v2/orders/anonymize\"\n}\n\nexport type AnonymizeOrdersErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type AnonymizeOrdersError =\n AnonymizeOrdersErrors[keyof AnonymizeOrdersErrors]\n\nexport type AnonymizeOrdersResponses = {\n /**\n * OK\n */\n 200: OrdersListResponse\n}\n\nexport type AnonymizeOrdersResponse =\n AnonymizeOrdersResponses[keyof AnonymizeOrdersResponses]\n\nexport type ConfirmOrderData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order to confirm.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/confirm\"\n}\n\nexport type ConfirmOrderErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type ConfirmOrderError = ConfirmOrderErrors[keyof ConfirmOrderErrors]\n\nexport type ConfirmOrderResponses = {\n /**\n * Order confirmed successfully\n */\n 200: OrderResponse\n}\n\nexport type ConfirmOrderResponse =\n ConfirmOrderResponses[keyof ConfirmOrderResponses]\n\nexport type PaymentSetupData = {\n body?: PaymentsRequest\n path: {\n /**\n * The Universally Unique Identifier (UUID) of the order you want to pay for.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/payments\"\n}\n\nexport type PaymentSetupErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Conflict\n */\n 409: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type PaymentSetupError = PaymentSetupErrors[keyof PaymentSetupErrors]\n\nexport type PaymentSetupResponses = {\n /**\n * OK\n */\n 200: TransactionEntityResponse\n}\n\nexport type PaymentSetupResponse =\n PaymentSetupResponses[keyof PaymentSetupResponses]\n\nexport type ConfirmPaymentData = {\n body?: OrdersTransactionsConfirmRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n /**\n * The unique identifier of the transaction.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/confirm\"\n}\n\nexport type ConfirmPaymentErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type ConfirmPaymentError =\n ConfirmPaymentErrors[keyof ConfirmPaymentErrors]\n\nexport type ConfirmPaymentResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type ConfirmPaymentResponse =\n ConfirmPaymentResponses[keyof ConfirmPaymentResponses]\n\nexport type CaptureATransactionData = {\n body?: OrdersTransactionsCaptureRequest\n path: {\n /**\n * The UUID of the order.\n */\n orderID: string\n /**\n * The UUID of the transaction to capture.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/capture\"\n}\n\nexport type CaptureATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type CaptureATransactionError =\n CaptureATransactionErrors[keyof CaptureATransactionErrors]\n\nexport type CaptureATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type CaptureATransactionResponse =\n CaptureATransactionResponses[keyof CaptureATransactionResponses]\n\nexport type RefundATransactionData = {\n body?: OrdersTransactionsRefundRequest\n path: {\n /**\n * The UUID of the order.\n */\n orderID: string\n /**\n * The UUID of the transaction you want to refund.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/refund\"\n}\n\nexport type RefundATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type RefundATransactionError =\n RefundATransactionErrors[keyof RefundATransactionErrors]\n\nexport type RefundATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type RefundATransactionResponse =\n RefundATransactionResponses[keyof RefundATransactionResponses]\n\nexport type GetOrderTransactionsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions\"\n}\n\nexport type GetOrderTransactionsErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type GetOrderTransactionsError =\n GetOrderTransactionsErrors[keyof GetOrderTransactionsErrors]\n\nexport type GetOrderTransactionsResponses = {\n 200: TransactionListResponse\n}\n\nexport type GetOrderTransactionsResponse =\n GetOrderTransactionsResponses[keyof GetOrderTransactionsResponses]\n\nexport type GetATransactionData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order that you require transactions for.\n */\n orderID: string\n /**\n * The unique identifier of the transaction.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}\"\n}\n\nexport type GetATransactionResponses = {\n 200: ResponseData & {\n data?: TransactionResponse\n }\n}\n\nexport type GetATransactionResponse =\n GetATransactionResponses[keyof GetATransactionResponses]\n\nexport type CancelATransactionData = {\n body?: OrdersTransactionsCancelRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n /**\n * The unique identifier of the transaction to be canceled or voided.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/cancel\"\n}\n\nexport type CancelATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type CancelATransactionError =\n CancelATransactionErrors[keyof CancelATransactionErrors]\n\nexport type CancelATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type CancelATransactionResponse =\n CancelATransactionResponses[keyof CancelATransactionResponses]\n\nexport type GetOrderShippingGroupsData = {\n body?: never\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups\"\n}\n\nexport type GetOrderShippingGroupsErrors = {\n /**\n * Order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetOrderShippingGroupsError =\n GetOrderShippingGroupsErrors[keyof GetOrderShippingGroupsErrors]\n\nexport type GetOrderShippingGroupsResponses = {\n /**\n * A list of shipping groups\n */\n 200: {\n data?: Array<ShippingGroupResponse>\n }\n}\n\nexport type GetOrderShippingGroupsResponse =\n GetOrderShippingGroupsResponses[keyof GetOrderShippingGroupsResponses]\n\nexport type CreateOrderShippingGroupData = {\n /**\n * Shipping group details\n */\n body?: {\n data?: {\n type: \"shipping_group\"\n /**\n * The shipping type for this group\n */\n shipping_type?: string\n /**\n * Tracking reference for the shipment\n */\n tracking_reference?: string\n address?: {\n first_name?: string\n last_name?: string\n phone_number?: string\n company_name?: string\n line_1?: string\n line_2?: string\n city?: string\n postcode?: string\n county?: string\n country?: string\n region?: string\n instructions?: string\n }\n delivery_estimate?: {\n start?: Date\n end?: Date\n }\n }\n }\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups\"\n}\n\nexport type CreateOrderShippingGroupErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Order not found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateOrderShippingGroupError =\n CreateOrderShippingGroupErrors[keyof CreateOrderShippingGroupErrors]\n\nexport type CreateOrderShippingGroupResponses = {\n /**\n * Shipping group created\n */\n 201: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type CreateOrderShippingGroupResponse =\n CreateOrderShippingGroupResponses[keyof CreateOrderShippingGroupResponses]\n\nexport type GetShippingGroupsByIdData = {\n body?: never\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n /**\n * The ID of the shipping group\n */\n shippingGroupID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups/{shippingGroupID}\"\n}\n\nexport type GetShippingGroupsByIdErrors = {\n /**\n * Shipping group or order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupsByIdError =\n GetShippingGroupsByIdErrors[keyof GetShippingGroupsByIdErrors]\n\nexport type GetShippingGroupsByIdResponses = {\n /**\n * Shipping group details\n */\n 200: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type GetShippingGroupsByIdResponse =\n GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses]\n\nexport type PutShippingGroupByIdData = {\n body: UpdateOrderShippingGroupRequest\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n /**\n * The ID of the shipping group\n */\n shippingGroupID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups/{shippingGroupID}\"\n}\n\nexport type PutShippingGroupByIdErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Shipping group or order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type PutShippingGroupByIdError =\n PutShippingGroupByIdErrors[keyof PutShippingGroupByIdErrors]\n\nexport type PutShippingGroupByIdResponses = {\n /**\n * Shipping group updated successfully\n */\n 200: ShippingGroupResponse\n}\n\nexport type PutShippingGroupByIdResponse =\n PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses]\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/client/types.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nexport type CartContact = {\n /**\n * The email address attached to a cart.\n */\n email?: string\n}\n\nexport type DiscountSettings = {\n /**\n * This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/settings/put-v-2-settings-cart).\n */\n custom_discounts_enabled?: boolean\n /**\n * When set to true, this parameter allows the cart to use rule promotions.\n */\n use_rule_promotions?: boolean\n}\n\nexport type InventorySettings = {\n /**\n * This parameter enables deferring inventory checks on the cart. This allows items to be added to or updating in the cart without checking stock levels. Inventory checks are still performed as normal on checkout\n */\n defer_inventory_check?: boolean\n}\n\n/**\n * Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.\n *\n * Example:\n * ```\n * \"custom_attributes\": {\n * \"is_member\": {\n * \"type\": \"boolean\",\n * \"value\": true\n * },\n * \"membership_level\": {\n * \"type\": \"string\",\n * \"value\": \"premium\"\n * }\n * }\n * ```\n *\n */\nexport type CustomAttributes = {\n [key: string]: unknown\n}\n\nexport type FormattedPriceData = {\n /**\n * The raw total.\n */\n amount?: number\n /**\n * The currency set for this amount.\n */\n currency?: string\n /**\n * The formatted total based on the amount and currency.\n */\n formatted?: string\n}\n\nexport type Timestamps = {\n /**\n * The date this was created.\n */\n created_at?: string\n /**\n * The date this was last updated.\n */\n updated_at?: unknown\n}\n\n/**\n * Relationship data entry\n */\nexport type RelationshipItem = {\n /**\n * The type of related resource.\n */\n type?: string\n /**\n * The ID of the related resource.\n */\n id?: string\n}\n\n/**\n * Array of relationships\n */\nexport type RelationshipArray = {\n /**\n * Individual relationships\n */\n data?: Array<RelationshipItem>\n}\n\nexport type CartResponse = {\n /**\n * The unique identifier for the cart. Use SDK or create it yourself.\n */\n id?: string\n /**\n * The type of object being returned.\n */\n type?: string\n /**\n * The name of this cart.\n */\n name?: string\n /**\n * A description of the cart.\n */\n description?: string\n contact?: CartContact\n discount_settings?: DiscountSettings\n inventory_settings?: InventorySettings\n /**\n * Stripe-assigned unique identifier for the linked Payment Intent\n */\n payment_intent_id?: string\n custom_attributes?: CustomAttributes\n links?: {\n /**\n * A link to that specific resource.\n */\n self?: string\n }\n meta?: {\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n without_discount?: FormattedPriceData\n shipping?: FormattedPriceData\n }\n timestamps?: Timestamps\n }\n relationships?: {\n customers?: RelationshipArray\n items?:\n | RelationshipArray\n | {\n data?: null\n }\n accounts?: RelationshipArray\n custom_discounts?: RelationshipArray\n promotions?: RelationshipArray\n }\n}\n\nexport type ResponsePageLinks = {\n /**\n * Always the current page.\n */\n current?: string\n /**\n * Always the first page.\n */\n first?: string\n /**\n * If there is only one page, it is `null`.\n */\n last?: string\n /**\n * If there is only one page, it is `null`.\n */\n next?: string\n /**\n * if the user is on the first page, it is `null`.\n */\n prev?: string\n}\n\nexport type ResponsePaginationPage = {\n /**\n * The current page.\n */\n current?: number\n /**\n * The maximum number of records per page for this response. You can set this value up to 100.\n */\n limit?: number\n /**\n * The current offset by number of records, not pages. Offset is zero-based.\n */\n offset?: number\n /**\n * The total page count.\n */\n total?: number\n}\n\nexport type ResponsePaginationResults = {\n /**\n * The total page count.\n */\n total?: number\n}\n\nexport type ResponseMetaCarts = {\n page?: ResponsePaginationPage\n results?: ResponsePaginationResults\n}\n\nexport type CartCollectionResponse = {\n data: Array<CartResponse>\n links?: ResponsePageLinks\n meta?: ResponseMetaCarts\n}\n\nexport type ResponseErrorItem = {\n /**\n * A brief summary of the error.\n */\n title: string\n /**\n * The HTTP response code of the error.\n */\n status: number\n /**\n * Optional additional detail about the error.\n */\n detail?: string\n meta?: {\n /**\n * The resource id associated with the error\n */\n id?: string\n ids?: Array<string>\n item_ids?: Array<string>\n /**\n * The shipping group id associated with the error\n */\n shipping_group_id?: string\n shipping_group_ids?: Array<string>\n /**\n * The cart id associated with the error\n */\n cart_id?: string\n /**\n * The code associated with the error.\n */\n code?: string\n /**\n * The order id associated with the error.\n */\n order_id?: string\n /**\n * The value associated with the error.\n */\n value?:\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n | Array<unknown>\n }\n}\n\nexport type ResponseErrorResponse = {\n errors: Array<ResponseErrorItem>\n}\n\nexport type CartsRequest = {\n data?: {\n /**\n * The cart description.\n */\n description?: string\n discount_settings?: DiscountSettings\n inventory_settings?: InventorySettings\n /**\n * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.\n */\n name?: string\n contact?: CartContact\n /**\n * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.\n */\n snapshot_date?: string\n /**\n * Specifies custom attributes for cart objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.\n *\n * Attribute types include:\n * - string\n * - boolean\n * - integer\n * - float\n *\n * Multiple custom attributes may be submitted together. A cart can have a maximum of 20 custom attributes.\n *\n * Example:\n * ```\n * \"custom_attributes\": {\n * \"is_member\": {\n * \"type\": \"boolean\",\n * \"value\": true\n * },\n * \"membership_level\": {\n * \"type\": \"string\",\n * \"value\": \"premium\"\n * }\n * }\n * ```\n *\n * Updating an existing cart with new custom attributes clears previously-saved attributes. In order to maintain existing custom attributes on a cart, please include them in the update request along with any new attributes.\n *\n */\n custom_attributes?: CustomAttributes\n /**\n * To remove the Stripe payment intent from a cart, pass the empty value in the `payment_intent_id` field. You must use an empty value for this field. You cannot use this endpoint to directly update the cart to use an existing Payment Intent.\n */\n payment_intent_id?: string\n }\n}\n\nexport type CartEntityResponse = {\n data: CartResponse\n}\n\n/**\n * The type of object being returned.\n */\nexport type Type = \"cart_item\"\n\nexport type CartItemObjectData = {\n /**\n * The type of object being returned.\n */\n type: \"cart_item\"\n /**\n * The number of items added to the cart.\n */\n quantity: number\n /**\n * Specifies the ID of the product you want to add to cart. (use this OR sku)\n */\n id?: string\n /**\n * Specifies the item SKU that you want to add to cart. (use this OR id)\n */\n sku?: string\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * Object used to describe the bundle options selected.\n */\n bundle_configuration?: {\n /**\n * Specifies selected options.\n */\n selected_options?: {\n [key: string]: unknown\n }\n /**\n * Array of component products for the selected options.\n */\n component_products?: Array<unknown>\n }\n /**\n * Identifier for a created Cart Shipping Group\n */\n shipping_group_id?: string\n /**\n * The slug of a stock location.\n */\n location?: string\n}\n\nexport type ItemPriceData = {\n /**\n * The amount for this item as an integer.\n */\n readonly amount?: number\n /**\n * The currency this item was added to the cart as.\n */\n readonly currency?: string\n /**\n * Whether or not this price is tax inclusive.\n */\n readonly includes_tax?: boolean\n}\n\nexport type CartItemFormattedPriceData = {\n /**\n * The amount per each single unit.\n */\n unit?: FormattedPriceData\n /**\n * The total amount of the item (i.e., unit * quantity).\n */\n value?: FormattedPriceData\n}\n\nexport type CartItemResponse = {\n /**\n * The unique ID of the product.\n */\n readonly product_id?: string\n /**\n * The unique ID of the subscription offering for subscription items.\n */\n readonly subscription_offering_id?: string\n /**\n * The name of this item\n */\n readonly name?: string\n /**\n * A description of the cart item.\n */\n readonly description?: string\n /**\n * The unique identifier of the catalog associated with the product is shown if catalog_source=pim is set.\n */\n readonly catalog_id?: string\n /**\n * The catalog source. Always `pim` or `legacy`.\n */\n readonly catalog_source?: string\n readonly image?: {\n /**\n * The MIME type for the uploaded file.\n */\n readonly mime_type?: string\n /**\n * The name of the image file that was uploaded.\n */\n readonly file_name?: string\n /**\n * The link to the image.\n */\n readonly href?: string\n }\n /**\n * Whether or not the quantity of the item will be checked against inventory.\n */\n readonly manage_stock?: boolean\n /**\n * The unit price of the item.\n */\n unit_price?: ItemPriceData\n /**\n * The total price of the item (i.e., unit * quantity).\n */\n value?: ItemPriceData\n readonly links?: {\n /**\n * A URL related to the resource.\n */\n product?: string\n }\n readonly meta?: {\n display_price?: {\n /**\n * The amount of this item after discounts and taxes are applied.\n */\n with_tax?: CartItemFormattedPriceData\n /**\n * The amount of this item after discounts are applied and before taxes.\n */\n without_tax?: CartItemFormattedPriceData\n /**\n * The amount of taxes applied to this item.\n */\n tax?: CartItemFormattedPriceData\n /**\n * The amount of the discount applied to this item.\n */\n discount?: CartItemFormattedPriceData\n without_discount?: CartItemFormattedPriceData\n }\n timestamps?: Timestamps\n }\n}\n\nexport type CartItemObject = CartItemObjectData & CartItemResponse\n\nexport type CustomItemObjectData = {\n /**\n * The type of object being returned. Must be `custom_item`.\n */\n type: \"custom_item\"\n /**\n * The number of custom items to add to cart.\n */\n quantity: number\n price: {\n /**\n * The unit price of the custom item.\n */\n amount: number\n /**\n * Set to`true` if relevant taxes have been included in the price, `false` if not. Defaults to `true`.\n */\n includes_tax?: boolean\n }\n /**\n * A description of the custom item.\n */\n description?: string\n /**\n * The `SKU` code to use for the custom item. See [best practices](https://elasticpath.dev/docs/commerce-cloud/carts/cart-items/add-custom-item-to-cart#best-practices) to use the `SKU` code.\n */\n sku?: string\n /**\n * The name of the custom item.\n */\n name: string\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * Identifier for a created Cart Shipping Group\n */\n shipping_group_id?: string\n}\n\nexport type CustomItemObject = {\n data?: CustomItemObjectData\n}\n\nexport type SubscriptionItemObjectData = {\n /**\n * The type of object being returned.\n */\n type: \"subscription_item\"\n /**\n * The number of items added to the cart.\n */\n quantity: number\n /**\n * Specifies the ID of the subscription offering you want to add to cart.\n */\n id: string\n /**\n * Specifies how the subscription offering should be configured.\n */\n subscription_configuration: {\n /**\n * The ID of the pricing option within the offering to use for the subscription.\n */\n pricing_option: string\n /**\n * The ID of the plan within the offering to use for the subscription.\n */\n plan: string\n }\n}\n\nexport type SubscriptionItemObject = {\n data?: SubscriptionItemObjectData & CartItemResponse\n}\n\nexport type PromotionItemObjectData = {\n /**\n * Specifies the type of resource, which is `promotion_item`.\n */\n type: \"promotion_item\"\n /**\n * Specifies the promotion code. For more information about codes[].user[], see the [Create Promotion codes](/docs/api/promotions/create-promotion-codes) section.\n */\n code: string\n}\n\nexport type PromotionItemObject = {\n data?: PromotionItemObjectData\n}\n\nexport type CartItemsResponse = {\n data?: Array<\n | CartItemObject\n | CustomItemObject\n | SubscriptionItemObject\n | PromotionItemObject\n >\n}\n\nexport type UpdateAllOrNothingOptionsObject = {\n /**\n * When set to`true`, if an error occurs for any item, no items are updated in the cart. When set to `false`, valid items are updated in the cart and the items with errors are reported in the response. Default is `true`.\n */\n update_all_or_nothing?: boolean\n}\n\nexport type BulkUpdateCartsItems = {\n data?: Array<{\n /**\n * Specifies the ID of the cart item that you want to update in cart.\n */\n id?: string\n /**\n * Specifies the amount of items to update in the cart.\n */\n quantity?: number\n /**\n * Specifies the custom text to be added to a product. See [custom inputs](https://elasticpath.dev/docs/pxm/products/ep-pxm-products-api/update-a-product#using-custom-inputs-attribute).\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n }>\n options?: UpdateAllOrNothingOptionsObject\n}\n\nexport type CartItemObjectRequest = {\n data?: CartItemObject\n}\n\nexport type CartMergeObject = {\n /**\n * The type of object being returned. Must be `cart_items`.\n */\n type: \"cart_items\"\n /**\n * The original cart to be merged from.\n */\n cart_id: string\n}\n\nexport type AddAllOrNothingOptionsObject = {\n /**\n * When `true`, if an error occurs for any item, no items are added to the cart. When `false`, valid items are added to the cart and the items with errors are reported in the response. Default is `false`.\n */\n add_all_or_nothing?: boolean\n}\n\nexport type CartMergeObjectRequest = {\n data?: CartMergeObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type ReOrderObject = {\n /**\n * The type of resource being returned. Use `order_items`.\n */\n type: \"order_items\"\n /**\n * The unique identifier of the order.\n */\n order_id: string\n}\n\nexport type ReOrderObjectRequest = {\n data?: ReOrderObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type BulkAddItemsRequest = {\n data?: Array<\n | CartItemObjectData\n | CartMergeObject\n | CustomItemObjectData\n | ReOrderObject\n | PromotionItemObjectData\n >\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartTimestamps = {\n created_at?: string\n updated_at?: unknown\n expires_at?: unknown\n}\n\nexport type CartsResponse = {\n data?: Array<\n | CartItemObject\n | CustomItemObject\n | SubscriptionItemObject\n | PromotionItemObject\n >\n meta?: {\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n without_discount?: FormattedPriceData\n discounts?: {\n [key: string]: {\n amount?: number\n currency?: string\n formatted?: string\n }\n }\n }\n timestamps?: CartTimestamps\n }\n}\n\nexport type UpdateCartsItems = {\n data?: {\n /**\n * The type of the cart item.\n */\n type?: \"cart_item\"\n /**\n * The unique identifier of the cart item.\n */\n id?: string\n /**\n * The amount of products to add to cart.\n */\n quantity?: number\n /**\n * The custom text to be added to a product.\n */\n custom_inputs?: {\n [key: string]: unknown\n }\n /**\n * The unique identifier of the shipping group to be added to the cart.\n */\n shipping_group_id?: string\n }\n}\n\nexport type CartsRelationshipsAccountsData = {\n data?: Array<{\n /**\n * The ID of the account.\n */\n id?: string\n /**\n * The type of related object. Ensure that it is account.\n */\n type?: string\n }>\n}\n\nexport type CartsRelationshipsCustomersData = {\n data?: Array<{\n /**\n * The ID of the customer.\n */\n id?: string\n /**\n * The type of related object. Ensure that it is customer.\n */\n type?: string\n }>\n}\n\nexport type CartsItemsTaxesObject = {\n /**\n * A unique tax code in this jurisdiction.\n */\n code?: string\n /**\n * The relevant tax jurisdiction.\n */\n jurisdiction?: string\n /**\n * The name of the tax item.\n */\n name?: string\n /**\n * The tax rate represented as a decimal (12.5% -> 0.125). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.\n */\n rate?: number\n /**\n * The tax rate represented as a number ($10 -> 1000). You can specify either `rate` or `amount`, but not both. Supplying both fields will result in an error.\n */\n amount?: number\n /**\n * The type of object being returned. Use `tax_item`.\n */\n type: string\n /**\n * The unique identifier for this tax item.\n */\n readonly id?: string\n}\n\nexport type CartItemTaxesEntityResponse = {\n data: CartsItemsTaxesObject\n}\n\nexport type CartItemRelationship = {\n relationships?: {\n order?: {\n data?: {\n /**\n * This specifies the type of item.\n */\n type?: string\n /**\n * This specifies the ID of the cart_item or custom_item in the cart.\n */\n id?: string\n }\n }\n }\n}\n\nexport type CartsBulkTaxes = {\n data?: Array<CartsItemsTaxesObject & CartItemRelationship>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsCustomDiscountsObject = {\n amount:\n | number\n | {\n amount?: number\n currency?: string\n formatted?: string\n }\n /**\n * Specifies a description for the custom discount.\n */\n description: string\n /**\n * Specifies the discount code used for the custom discount.\n */\n discount_code: string\n /**\n * Specifies from where the custom discount is applied. For example, Talon.one.\n */\n discount_engine: string\n /**\n * Specifies an external id for the custom discount.\n */\n external_id: string\n /**\n * Specifies the type of the resource. Always `custom_discount`.\n */\n type: string\n}\n\nexport type CustomDiscountRelationshipsCartItemRequest = {\n relationships?: {\n item?: {\n data?: {\n /**\n * Specifies the type of item. For example, `custom_item` or `cart_item`.\n */\n type?: string\n /**\n * Specifies the unique identifier of the `cart_item` or `custom_item` in the cart.\n */\n id?: string\n }\n }\n }\n}\n\nexport type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject &\n CustomDiscountRelationshipsCartItemRequest\n\nexport type CartsBulkCustomDiscounts = {\n data?: Array<CartsCustomDiscountsObject & CartItemBulkCustomDiscountObject>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsBulkCustomDiscountsResponse = {\n data?: CartsCustomDiscountsObject\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsBulkCustomDiscountsCollectionResponse = {\n data?: Array<CartsCustomDiscountsObject>\n options?: AddAllOrNothingOptionsObject\n}\n\nexport type CartsCustomDiscountsResponseObject = {\n amount?: {\n /**\n * Specifies an amount to be applied for the custom discount. It must be less than zero.\n */\n amount?: number\n /**\n * The currency set for the custom discount.\n */\n currency?: string\n /**\n * The formatted value for the custom discount.\n */\n formatted?: string\n }\n /**\n * Specifies a description for the custom discount.\n */\n description?: string\n /**\n * Specifies the discount code used for the custom discount.\n */\n discount_code?: string\n /**\n * Specifies from where the custom discount is applied. For example, Talon.one.\n */\n discount_engine?: string\n /**\n * Specifies an external id for the custom discount.\n */\n external_id?: string\n /**\n * Specifies the type of the resource. Always `custom_discount`.\n */\n type?: string\n /**\n * Specifies the UUID of the custom discount.\n */\n readonly id?: string\n}\n\nexport type CartsCustomDiscountsEntityRequest = {\n data?: CartsCustomDiscountsResponseObject\n}\n\nexport type CartsCustomDiscountsEntityResponse = {\n data?: CartsCustomDiscountsObject\n}\n\nexport type CartsCustomDiscountsCollectionResponse = {\n data?: Array<CartsCustomDiscountsObject>\n}\n\nexport type ShippingAddress = {\n /**\n * First name of the shipping recipient.\n */\n first_name: string\n /**\n * Last name of the shipping recipient.\n */\n last_name: string\n /**\n * Phone number of the shipping recipient.\n */\n phone_number: string\n /**\n * Company of the shipping recipient.\n */\n company_name: string\n /**\n * First line of the shipping address.\n */\n line_1: string\n /**\n * Second line of the shipping address.\n */\n line_2: string\n /**\n * City of the shipping address.\n */\n city: string\n /**\n * Post code of the shipping address.\n */\n postcode: string\n /**\n * County of the shipping address.\n */\n county: string\n /**\n * Country of the shipping address.\n */\n country: string\n /**\n * State, province, or region of the shipping address.\n */\n region?: string\n /**\n * Delivery instructions.\n */\n instructions: string\n}\n\nexport type DeliveryEstimate = {\n start?: Date\n end?: Date\n}\n\nexport type Money = {\n /**\n * Amount in minor currency units (e.g., cents).\n */\n amount: number\n /**\n * ISO 4217 currency code (e.g., \"USD\").\n */\n currency: string\n /**\n * Whether the amount includes tax.\n */\n includes_tax: boolean\n}\n\nexport type Discount = {\n amount: Money\n /**\n * The discount code used, if applicable.\n */\n code?: string\n /**\n * Unique identifier for the discount.\n */\n id: string\n /**\n * The source or origin of the promotion, if applicable.\n */\n promotion_source?: string\n /**\n * Indicates whether the discount applies to the entire cart.\n */\n is_cart_discount?: boolean\n /**\n * Order in which the discount was applied.\n */\n ordinal?: number\n}\n\nexport type Discounts = Array<Discount>\n\nexport type ShippingPriceResponse = {\n total: FormattedPriceData\n base: FormattedPriceData\n tax?: FormattedPriceData\n fees?: FormattedPriceData\n discount?: FormattedPriceData\n}\n\nexport type OrderPriceWrapperMeta = {\n with_tax: FormattedPriceData\n without_tax: FormattedPriceData\n tax: FormattedPriceData\n discount: FormattedPriceData\n balance_owing: FormattedPriceData\n paid: FormattedPriceData\n authorized: FormattedPriceData\n without_discount: FormattedPriceData\n shipping: FormattedPriceData\n shipping_discount: FormattedPriceData\n}\n\nexport type ShippingGroupMeta = {\n shipping_display_price?: ShippingPriceResponse\n total_display_price?: OrderPriceWrapperMeta\n}\n\nexport type ShippingGroupResponse = {\n type?: \"shipping_group\"\n id?: string\n relation?: string\n cart_id?: string\n order_id?: string\n shipping_type?: string\n tracking_reference?: string\n /**\n * An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n address?: ShippingAddress\n delivery_estimate?: DeliveryEstimate\n createdAt?: Date\n updatedAt?: Date\n relationships?: {\n cart?: RelationshipItem\n order?: RelationshipItem\n }\n discounts?: Discounts\n meta?: ShippingGroupMeta\n}\n\nexport type ShippingPriceRequest = {\n total?: number\n base?: number\n tax?: number\n fees?: number\n discount?: number\n}\n\nexport type CreateShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n /**\n * An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.\n */\n external_ref?: string\n shipping_price?: ShippingPriceRequest\n address?: ShippingAddress\n includes_tax?: boolean\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type UpdateCartShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n /**\n * An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.\n */\n external_ref?: string\n shipping_price?: ShippingPriceRequest\n address?: ShippingAddress\n includes_tax?: boolean\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type Gateway =\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n\n/**\n * Specifies the transaction method, such as `purchase` or `authorize`.\n */\nexport type Method =\n | \"authorize\"\n | \"purchase\"\n | \"purchase_setup\"\n | \"authorize_setup\"\n\nexport type DataBasePayments = {\n gateway:\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n /**\n * Specifies the transaction method, such as `purchase` or `authorize`.\n */\n method: \"authorize\" | \"purchase\" | \"purchase_setup\" | \"authorize_setup\"\n /**\n * The amount to be paid for the transaction.\n */\n amount?: number\n}\n\nexport type ElasticPathPaymentsPoweredByStripePayment = {\n data?: DataBasePayments & {\n /**\n * Specifies the gateway. You must use `elastic_path_payments_stripe`.\n */\n gateway?: \"elastic_path_payments_stripe\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n /**\n * Parent object determining whether to use Stripe's `automatic_payment_methods` setting.\n */\n automatic_payment_methods?: {\n /**\n * When set to true, it displays all enabled payment methods from the Stripe dashboard. When set to false, the Stripe default, which is card, is used.\n */\n enabled?: boolean\n }\n }\n /**\n * Specifies the Stripe payment method types configured for the store. See [Stripe Documentation](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_types).\n */\n payment_method_types?: Array<string>\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n }\n}\n\nexport type CartPaymentUpdate = {\n data: {\n gateway: string\n method: string\n payment_method_types: Array<string>\n amount: number\n options?: {\n [key: string]: unknown\n }\n }\n}\n\nexport type BillingAddress = {\n /**\n * First name of the billing recipient.\n */\n first_name: string\n /**\n * Last name of the billing recipient.\n */\n last_name: string\n /**\n * Company name of the billing recipient.\n */\n company_name: string\n /**\n * First line of the billing address.\n */\n line_1: string\n /**\n * Second line of the billing address.\n */\n line_2: string\n /**\n * City of the billing address.\n */\n city: string\n /**\n * Postcode of the billing address.\n */\n postcode: string\n /**\n * County of the billing address.\n */\n county: string\n /**\n * Country of the billing address.\n */\n country: string\n /**\n * State, province, or region of the billing address.\n */\n region?: string\n}\n\nexport type CustomerCheckout = {\n data?: {\n /**\n * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n customer?: {\n /**\n * The ID of the customer.\n */\n id?: string\n /**\n * The email of the customer.\n */\n email?: string\n /**\n * The name of the customer.\n */\n name?: string\n }\n billing_address?: BillingAddress\n shipping_address?: ShippingAddress\n }\n}\n\nexport type AccountCheckout = {\n data?: {\n /**\n * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n account?: {\n /**\n * The account ID.\n */\n id?: string\n /**\n * The account member ID.\n */\n member_id?: string\n }\n contact?: {\n /**\n * The name of the account member.\n */\n name?: string\n /**\n * The email address of the account member.\n */\n email?: string\n }\n billing_address?: BillingAddress\n shipping_address?: ShippingAddress\n }\n}\n\nexport type OrderMeta = {\n timestamps?: Timestamps\n display_price?: {\n with_tax?: FormattedPriceData\n without_tax?: FormattedPriceData\n tax?: FormattedPriceData\n discount?: FormattedPriceData\n balance_owing?: FormattedPriceData\n paid?: FormattedPriceData\n authorized?: FormattedPriceData\n without_discount?: FormattedPriceData\n shipping?: FormattedPriceData\n shipping_discount?: FormattedPriceData\n }\n}\n\nexport type Contact = {\n /**\n * The email address of the contact.\n */\n email?: string\n /**\n * The name of the contact.\n */\n name?: string\n}\n\n/**\n * Single relationship\n */\nexport type SingleRelationship = {\n data?: RelationshipItem\n}\n\n/**\n * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.\n */\nexport type Status = \"complete\" | \"incomplete\" | \"cancelled\" | \"processing\"\n\n/**\n * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.\n */\nexport type Payment =\n | \"authorized\"\n | \"paid\"\n | \"unpaid\"\n | \"refunded\"\n | \"partially_paid\"\n | \"partially_authorized\"\n\n/**\n * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.\n */\nexport type Shipping = \"unfulfilled\" | \"fulfilled\"\n\nexport type OrderResponse = {\n /**\n * Specifies the type of object being returned. You must use `order`.\n */\n type?: \"order\"\n /**\n * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n /**\n * Specifies the unique identifier of the order.\n */\n readonly id?: string\n /**\n * Specifies the status of the order, such as `incomplete`, `complete`, `processing`, or `cancelled`.\n */\n status?: \"complete\" | \"incomplete\" | \"cancelled\" | \"processing\"\n /**\n * Specifies the status of the payment, such as `unpaid`, `authorized`, `paid`, or `refunded`.\n */\n payment?:\n | \"authorized\"\n | \"paid\"\n | \"unpaid\"\n | \"refunded\"\n | \"partially_paid\"\n | \"partially_authorized\"\n /**\n * Specifies the status of the shipment, such as `fulfilled` or `unfulfilled`.\n */\n shipping?: \"unfulfilled\" | \"fulfilled\"\n /**\n * Specifies if the order is anonymized.\n */\n anonymized?: boolean\n /**\n * Stripe Payment Intent ID. Please see Stripe's Payment Intent [documentation](https://docs.stripe.com/api/payment_intents) for more information on Payment Intents.\n */\n payment_intent_id?: string\n custom_attributes?: CustomAttributes\n meta?: OrderMeta\n billing_address?: BillingAddress\n contact?: Contact\n customer?: Contact\n shipping_address?: ShippingAddress\n relationships?: {\n items?: RelationshipArray\n custom_discounts?: RelationshipArray\n promotions?: RelationshipArray\n customer?: SingleRelationship\n account?: SingleRelationship\n account_member?: SingleRelationship\n }\n}\n\nexport type OrderEntityResponse = {\n data?: OrderResponse\n}\n\nexport type ResponseMetaOrders = {\n page?: ResponsePaginationPage\n results?: ResponsePaginationResults\n}\n\nexport type OrderCollectionResponse = {\n data?: Array<OrderResponse>\n links?: ResponsePageLinks\n meta?: ResponseMetaOrders\n}\n\nexport type OrdersAddressData = {\n /**\n * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.\n */\n order_number?: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n shipping_address: {\n /**\n * Specifies the first name of the address holder.\n */\n first_name?: string\n /**\n * Specifies the last name of the address holder.\n */\n last_name?: string\n /**\n * Specifies the phone number of the address holder.\n */\n phone_number?: string\n /**\n * Specifies the company name.\n */\n company_name?: string\n /**\n * Specifies the first line of the address.\n */\n line_1?: string\n /**\n * Specifies the second line of the address.\n */\n line_2?: string\n /**\n * Specifies the name of the city in the shipping address.\n */\n city?: string\n /**\n * Specifies the county of the shipping address.\n */\n county?: string\n /**\n * Specifies the state, province, or region of the shipping address.\n */\n region?: string\n /**\n * Specifies the postcode or ZIP code of the address.\n */\n postcode?: string\n /**\n * Specifies the country in the shipping address.\n */\n country?: string\n /**\n * Specifies any instructions provided with the shipping address.\n */\n instructions?: string\n }\n}\n\nexport type OrdersCancelData = {\n /**\n * The status of the order. You can only update the status to `cancelled`.\n */\n status: string\n /**\n * The type of the resource. You must use order.\n */\n type: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n}\n\nexport type OrdersFulfilledData = {\n /**\n * The shipping status of the order. You can only update the shipping status to `fulfilled`.\n */\n shipping: string\n /**\n * The type of the resource. You must use order.\n */\n type: string\n /**\n * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.\n */\n external_ref?: string\n}\n\nexport type OrdersUpdateRequest = {\n data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData\n}\n\nexport type OrderPriceData = {\n /**\n * The amount for this item.\n */\n amount?: number\n /**\n * The currency this item.\n */\n currency?: string\n /**\n * Whether this price is tax inclusive.\n */\n includes_tax?: boolean\n}\n\nexport type DiscountData = {\n amount?: OrderPriceData\n code?: string\n readonly id?: string\n}\n\nexport type OrderItemFormattedUnitPriceData = {\n unit?: FormattedPriceData\n value?: FormattedPriceData\n}\n\nexport type OrderItemResponse = {\n /**\n * The type represents the object being returned.\n */\n type?: string\n /**\n * The unique identifier for this order item.\n */\n readonly id?: string\n /**\n * The quantity of this item were ordered.\n */\n quantity?: number\n /**\n * The unique identifier for this order item.\n */\n readonly product_id?: string\n /**\n * The unique identifier for the subscription offering for this order item.\n */\n readonly subscription_offering_id?: string\n /**\n * The name of this order item.\n */\n name?: string\n /**\n * The SKU code for the order item.\n */\n sku?: string\n unit_price?: OrderPriceData\n value?: OrderPriceData\n discounts?: Array<DiscountData>\n links?: {\n [key: string]: unknown\n }\n meta?: {\n display_price?: {\n with_tax?: OrderItemFormattedUnitPriceData\n without_tax?: OrderItemFormattedUnitPriceData\n tax?: OrderItemFormattedUnitPriceData\n discount?: OrderItemFormattedUnitPriceData\n without_discount?: OrderItemFormattedUnitPriceData\n discounts?: {\n [key: string]: {\n amount?: number\n currency?: string\n formatted?: string\n }\n }\n }\n timestamps?: Timestamps\n }\n relationships?: {\n cart_item?: {\n data?: {\n /**\n * The type represents the object being returned.\n */\n type?: string\n /**\n * The unique identifier for this item.\n */\n readonly id?: string\n }\n }\n }\n /**\n * The unique identifier of the catalog associated with the product is shown if `catalog_source=pim` is set.\n */\n catalog_id?: string\n /**\n * The catalog source. Always `pim` or `legacy`.\n */\n catalog_source?: string\n}\n\nexport type OrderItemCollectionResponse = {\n data?: Array<OrderItemResponse>\n}\n\nexport type OrdersAnonymizeData = {\n /**\n * The unique identifiers of the orders to be anonymized. You can anonymize multiple orders at the same time.\n */\n order_ids?: Array<string>\n}\n\nexport type OrdersAnonymizeRequest = {\n data?: OrdersAnonymizeData\n}\n\nexport type OrdersListResponse = {\n data: Array<OrderResponse>\n}\n\nexport type DataAdyenPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `adyen`.\n */\n gateway: \"adyen\"\n options?: {\n /**\n * The shopper reference token associated with the saved payment method.\n */\n shopper_reference?: string\n /**\n * Enter CardOnFile for a one-time purchase.\n */\n recurring_processing_model?: string\n }\n /**\n * The Adyen recurringDetailReference payment method identifier.\n */\n payment: string\n}\n\nexport type DataAuthorizeNetPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `authorize_net`.\n */\n gateway: \"authorize_net\"\n options?: {\n /**\n * The Authorize.net customer payment profile ID.\n */\n customer_payment_profile_id?: string\n }\n /**\n * The Authorize.net customer profile ID.\n */\n payment: string\n}\n\nexport type DataBraintreePayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `braintree`.\n */\n gateway: \"braintree\"\n /**\n * The Braintree Customer ID that you want to bill.\n */\n payment: string\n}\n\nexport type DataCardConnectPayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `card_connect`.\n */\n gateway: \"card_connect\"\n /**\n * Enter account_id, profile_id from CardPointe API. For example, 1|16178397535388255208.\n */\n payment: string\n}\n\nexport type DataCyberSourcePayment = DataBasePayments & {\n /**\n * Specifies the gateway. You must use `cyber_source`.\n */\n gateway: \"cyber_source\"\n /**\n * The CyberSource token.\n */\n payment: string\n}\n\nexport type DataManualPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `manual`.\n */\n gateway: \"manual\"\n paymentmethod_meta?: {\n /**\n * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend not to include personal information in this field.\n */\n custom_reference?: string\n /**\n * A custom name associated with the payment method.\n */\n name?: string\n }\n}\n\nexport type DataPayPalExpressCheckoutPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `paypal_express_checkout`.\n */\n gateway: \"paypal_express_checkout\"\n options?: {\n /**\n * The description for the payment.\n */\n description?: string\n /**\n * The descriptor appended to PayPal generated descriptor that is visible on the card statement of the payer.\n */\n soft_descriptor?: string\n application_context?: {\n /**\n * The label that overrides the business name in the PayPal account on the PayPal site.\n */\n brand_name?: string\n /**\n * The locale pages that appear based on language and country code. PayPal supports a five-character code. For example, ja-JP.\n */\n locale?: string\n /**\n * The type of landing page to show on the PayPal site for customer checkout. Use values LOGIN, BILLING, or NO_PREFERENCE.\n */\n landing_page?: string\n /**\n * The shipping preference. Use SET_PROVIDED_ADDRESS value. This parameter does allow the user to change their address on PayPal site.\n */\n shipping_preference?: string\n /**\n * If you set `useraction=commit` in the query string, the flow redirects the buyer to the PayPal payment page and displays a Pay Now button. When the shopper clicks **Pay Now**, call `DoExpressCheckoutPayment` to complete the payment without additional interaction from the shopper. Choose this flow when you know the final payment amount when you initiate the checkout flow.\n */\n user_action?: string\n /**\n * The callback URL for PayPal to redirect the user in the case of approved payment.\n */\n return_url?: string\n /**\n * The callback URL for PayPal to redirect user in the case a cancelled payment.\n */\n cancel_url?: string\n }\n }\n}\n\nexport type DataStripePayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe`.\n */\n gateway: \"stripe\"\n options?: {\n /**\n * The option to provide an email for Stripe receipts. Specify live mode to access this feature.\n */\n receipt_email?: string\n }\n /**\n * The Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataStripeConnectPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe_connect`.\n */\n gateway: \"stripe_connect\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n }\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataStripePaymentIntentsPayment = DataBasePayments & {\n /**\n * Specifies the type of payment gateway. You must use `stripe_payment_intents`.\n */\n gateway: \"stripe_payment_intents\"\n options?: {\n /**\n * Provides the email address to which you want to send the Stripe receipts for the transactions within the store. This feature is available only in the live mode.\n */\n receipt_email?: string\n }\n /**\n * Specifies the Stripe token or source.\n */\n payment?: string\n}\n\nexport type DataPaymentObject =\n | DataAdyenPayment\n | DataAuthorizeNetPayment\n | DataBraintreePayment\n | DataCardConnectPayment\n | DataCyberSourcePayment\n | ElasticPathPaymentsPoweredByStripePayment\n | DataManualPayment\n | DataPayPalExpressCheckoutPayment\n | DataStripePayment\n | DataStripeConnectPayment\n | DataStripePaymentIntentsPayment\n\nexport type PaymentsRequest = {\n data?: DataPaymentObject\n}\n\nexport type TransactionResponse = {\n /**\n * The ID of the transaction.\n */\n readonly id?: string\n /**\n * The payment gateway reference.\n */\n reference?: string\n /**\n * A custom name associated with the payment method.\n */\n name?: string\n /**\n * A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.\n */\n custom_reference?: string\n /**\n * The name of the payment gateway used.\n */\n gateway?:\n | \"adyen\"\n | \"authorize_net\"\n | \"braintree\"\n | \"card_connect\"\n | \"cyber_source\"\n | \"elastic_path_payments_stripe\"\n | \"manual\"\n | \"paypal_express_checkout\"\n | \"stripe\"\n | \"stripe_connect\"\n | \"stripe_payment_intents\"\n | \"stripe_platform_account\"\n /**\n * The amount for this transaction.\n */\n amount?: number\n /**\n * The refunded amount.\n */\n refunded_amount?: number\n /**\n * The transaction currency.\n */\n currency?: string\n /**\n * The type of transaction, such as `purchase`, `capture`, `authorize` or `refund`.\n */\n \"transaction-type\"?: string\n /**\n * The status provided by the gateway for this transaction, such as `complete` or `failed`.\n */\n status?: string\n relationships?: {\n order?: {\n data?: {\n /**\n * Represents the type of the object being returned. It is always `order`.\n */\n type?: string\n /**\n * The ID of the order.\n */\n id?: string\n }\n }\n }\n meta?: {\n display_price?: FormattedPriceData\n display_refunded_amount?: FormattedPriceData\n timestamps?: Timestamps\n }\n}\n\nexport type TransactionEntityResponse = {\n data: TransactionResponse\n}\n\nexport type OrdersTransactionsConfirmRequest = {\n data?: {\n [key: string]: unknown\n }\n}\n\nexport type OrdersTransactionsCaptureRequest = {\n data?: {\n options?: {\n soft_descriptor?: string\n note_to_payer?: string\n }\n }\n}\n\nexport type OrdersTransactionsRefundRequest = {\n data?: {\n /**\n * The amount value to be refunded. If this field is not provided, it will be considered as manual refund (Mark as Refunded) and the refund process must be manually handled via payment provider. If the amount value is same as payment value, then it will be treated as a full refund and sent to the payment provider to process refund automatically.\n */\n amount?: number\n options?: {\n /**\n * Provides comments about the refund. It is used by PayPal Express.\n */\n note?: string\n }\n }\n}\n\nexport type TransactionListResponse = {\n data: Array<TransactionResponse>\n}\n\nexport type ResponseData = {\n data?: unknown\n}\n\nexport type OrdersTransactionsCancelRequest = {\n data?: {\n options?: {\n [key: string]: unknown\n }\n /**\n * Specifies the reason for canceling the transaction. The reason may include `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`.\n */\n reason?: string\n }\n}\n\nexport type UpdateOrderShippingGroupRequest = {\n data?: {\n type?: \"shipping_group\"\n shipping_type?: string\n tracking_reference?: string\n /**\n * An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.\n */\n external_ref?: string\n address?: ShippingAddress\n delivery_estimate?: DeliveryEstimate\n }\n}\n\nexport type GetCartsData = {\n body?: never\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/carts\"\n}\n\nexport type GetCartsErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n title?: string\n }>\n }\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n}\n\nexport type GetCartsError = GetCartsErrors[keyof GetCartsErrors]\n\nexport type GetCartsResponses = {\n 200: CartCollectionResponse\n}\n\nexport type GetCartsResponse = GetCartsResponses[keyof GetCartsResponses]\n\nexport type CreateACartData = {\n body?: CartsRequest\n headers?: {\n /**\n * A customer token to be associated with the cart.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/carts\"\n}\n\nexport type CreateACartErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n}\n\nexport type CreateACartError = CreateACartErrors[keyof CreateACartErrors]\n\nexport type CreateACartResponses = {\n 201: CartEntityResponse\n}\n\nexport type CreateACartResponse =\n CreateACartResponses[keyof CreateACartResponses]\n\nexport type DeleteACartData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart that you want to delete.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type DeleteACartErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type DeleteACartError = DeleteACartErrors[keyof DeleteACartErrors]\n\nexport type DeleteACartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteACartResponse =\n DeleteACartResponses[keyof DeleteACartResponses]\n\nexport type GetACartData = {\n body?: never\n path: {\n /**\n * The unique identifier for this cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type GetACartErrors = {\n /**\n * Bad Request\n */\n 400: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n}\n\nexport type GetACartError = GetACartErrors[keyof GetACartErrors]\n\nexport type GetACartResponses = {\n /**\n * OK\n */\n 200: CartEntityResponse\n}\n\nexport type GetACartResponse = GetACartResponses[keyof GetACartResponses]\n\nexport type UpdateACartData = {\n body?: CartsRequest\n path: {\n /**\n * The unique identifier of a cart created by you.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}\"\n}\n\nexport type UpdateACartErrors = {\n /**\n * Unauthorized call\n */\n 403: ResponseErrorResponse\n /**\n * Unprocessable Content\n */\n 422: {\n errors?: Array<{\n detail?: string\n status?: number\n title?: string\n }>\n }\n}\n\nexport type UpdateACartError = UpdateACartErrors[keyof UpdateACartErrors]\n\nexport type UpdateACartResponses = {\n 200: CartEntityResponse\n}\n\nexport type UpdateACartResponse =\n UpdateACartResponses[keyof UpdateACartResponses]\n\nexport type DeleteAllCartItemsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart created by you.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type DeleteAllCartItemsErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type DeleteAllCartItemsError =\n DeleteAllCartItemsErrors[keyof DeleteAllCartItemsErrors]\n\nexport type DeleteAllCartItemsResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAllCartItemsResponse =\n DeleteAllCartItemsResponses[keyof DeleteAllCartItemsResponses]\n\nexport type GetCartItemsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type GetCartItemsResponses = {\n 200: CartItemsResponse\n}\n\nexport type GetCartItemsResponse =\n GetCartItemsResponses[keyof GetCartItemsResponses]\n\nexport type ManageCartsData = {\n body?:\n | CartItemObjectRequest\n | SubscriptionItemObject\n | CartMergeObjectRequest\n | CustomItemObject\n | ReOrderObjectRequest\n | PromotionItemObject\n | BulkAddItemsRequest\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type ManageCartsErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n /**\n * Internal Server Error\n */\n 500: ResponseErrorResponse\n}\n\nexport type ManageCartsError = ManageCartsErrors[keyof ManageCartsErrors]\n\nexport type ManageCartsResponses = {\n 201: CartsResponse\n}\n\nexport type ManageCartsResponse =\n ManageCartsResponses[keyof ManageCartsResponses]\n\nexport type BulkUpdateItemsInCartData = {\n body?: BulkUpdateCartsItems\n path: {\n /**\n * The unique identifier of the cart that you created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items\"\n}\n\nexport type BulkUpdateItemsInCartErrors = {\n /**\n * Insufficient Stock\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkUpdateItemsInCartError =\n BulkUpdateItemsInCartErrors[keyof BulkUpdateItemsInCartErrors]\n\nexport type BulkUpdateItemsInCartResponses = {\n 200: unknown\n}\n\nexport type DeleteACartItemData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart created by you.\n */\n cartID: string\n /**\n * The unique identifier of the cart that you want to delete.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}\"\n}\n\nexport type DeleteACartItemResponses = {\n 200: CartsResponse\n}\n\nexport type DeleteACartItemResponse =\n DeleteACartItemResponses[keyof DeleteACartItemResponses]\n\nexport type UpdateACartItemData = {\n body?: UpdateCartsItems\n path: {\n /**\n * A unique identifier of the cart that you created.\n */\n cartID: string\n /**\n * A unique identifier of the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}\"\n}\n\nexport type UpdateACartItemErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n}\n\nexport type UpdateACartItemError =\n UpdateACartItemErrors[keyof UpdateACartItemErrors]\n\nexport type UpdateACartItemResponses = {\n 200: CartsResponse\n}\n\nexport type UpdateACartItemResponse =\n UpdateACartItemResponses[keyof UpdateACartItemResponses]\n\nexport type DeleteAccountCartAssociationData = {\n body?: CartsRelationshipsAccountsData\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the account.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/accounts\"\n}\n\nexport type DeleteAccountCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n}\n\nexport type DeleteAccountCartAssociationError =\n DeleteAccountCartAssociationErrors[keyof DeleteAccountCartAssociationErrors]\n\nexport type DeleteAccountCartAssociationResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAccountCartAssociationResponse =\n DeleteAccountCartAssociationResponses[keyof DeleteAccountCartAssociationResponses]\n\nexport type CreateAccountCartAssociationData = {\n body?: CartsRelationshipsAccountsData\n headers?: {\n /**\n * An Account Management Authentication token to access a specific account's carts.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the account. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/accounts\"\n}\n\nexport type CreateAccountCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateAccountCartAssociationError =\n CreateAccountCartAssociationErrors[keyof CreateAccountCartAssociationErrors]\n\nexport type CreateAccountCartAssociationResponses = {\n /**\n * OK\n */\n 200: CartsRelationshipsAccountsData\n /**\n * No Content is sent back in case the account has already been associated to the cart.\n */\n 204: void\n}\n\nexport type CreateAccountCartAssociationResponse =\n CreateAccountCartAssociationResponses[keyof CreateAccountCartAssociationResponses]\n\nexport type DeleteCustomerCartAssociationData = {\n body?: CartsRelationshipsCustomersData\n headers?: {\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the customer.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/customers\"\n}\n\nexport type DeleteCustomerCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n}\n\nexport type DeleteCustomerCartAssociationError =\n DeleteCustomerCartAssociationErrors[keyof DeleteCustomerCartAssociationErrors]\n\nexport type DeleteCustomerCartAssociationResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomerCartAssociationResponse =\n DeleteCustomerCartAssociationResponses[keyof DeleteCustomerCartAssociationResponses]\n\nexport type CreateCustomerCartAssociationData = {\n body?: CartsRelationshipsCustomersData\n headers?: {\n /**\n * A customer token to access a specific customer's carts.\n */\n \"x-moltin-customer-token\"?: string\n }\n path: {\n /**\n * The ID for the cart created by the customer. Ensure that you follow the guidelines for [Safe Characters](/guides/Getting-Started/safe-characters).\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/relationships/customers\"\n}\n\nexport type CreateCustomerCartAssociationErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Forbidden\n */\n 403: ResponseErrorResponse\n /**\n * Unauthorized\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateCustomerCartAssociationError =\n CreateCustomerCartAssociationErrors[keyof CreateCustomerCartAssociationErrors]\n\nexport type CreateCustomerCartAssociationResponses = {\n /**\n * OK\n */\n 200: CartsRelationshipsCustomersData\n /**\n * No Content\n */\n 204: void\n}\n\nexport type CreateCustomerCartAssociationResponse =\n CreateCustomerCartAssociationResponses[keyof CreateCustomerCartAssociationResponses]\n\nexport type DeleteAPromotionViaPromotionCodeData = {\n body?: never\n path: {\n /**\n * Specifies the unique identifier of a cart created by you.\n */\n cartID: string\n /**\n * Specifies the promotion code to be deleted.\n */\n promoCode: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/discounts/{promoCode}\"\n}\n\nexport type DeleteAPromotionViaPromotionCodeResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteAPromotionViaPromotionCodeResponse =\n DeleteAPromotionViaPromotionCodeResponses[keyof DeleteAPromotionViaPromotionCodeResponses]\n\nexport type AddTaxItemToCartData = {\n body?: CartItemTaxesEntityResponse\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes\"\n}\n\nexport type AddTaxItemToCartErrors = {\n /**\n * Unauthorized\n */\n 422: ResponseErrorResponse\n}\n\nexport type AddTaxItemToCartError =\n AddTaxItemToCartErrors[keyof AddTaxItemToCartErrors]\n\nexport type AddTaxItemToCartResponses = {\n 200: CartItemTaxesEntityResponse\n /**\n * Created\n */\n 201: CartItemTaxesEntityResponse\n}\n\nexport type AddTaxItemToCartResponse =\n AddTaxItemToCartResponses[keyof AddTaxItemToCartResponses]\n\nexport type BulkDeleteTaxItemsFromCartData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/taxes\"\n}\n\nexport type BulkDeleteTaxItemsFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type BulkDeleteTaxItemsFromCartResponse =\n BulkDeleteTaxItemsFromCartResponses[keyof BulkDeleteTaxItemsFromCartResponses]\n\nexport type BulkAddTaxItemsToCartData = {\n body?: CartsBulkTaxes\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/taxes\"\n}\n\nexport type BulkAddTaxItemsToCartErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkAddTaxItemsToCartError =\n BulkAddTaxItemsToCartErrors[keyof BulkAddTaxItemsToCartErrors]\n\nexport type BulkAddTaxItemsToCartResponses = {\n 200: CartsBulkTaxes\n /**\n * Created\n */\n 201: CartsBulkTaxes\n}\n\nexport type BulkAddTaxItemsToCartResponse =\n BulkAddTaxItemsToCartResponses[keyof BulkAddTaxItemsToCartResponses]\n\nexport type DeleteATaxItemData = {\n body?: never\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n /**\n * The unique identifier of the tax item.\n */\n taxitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}\"\n}\n\nexport type DeleteATaxItemResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteATaxItemResponse =\n DeleteATaxItemResponses[keyof DeleteATaxItemResponses]\n\nexport type UpdateATaxItemData = {\n body?: CartItemTaxesEntityResponse\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the cart item.\n */\n cartitemID: string\n /**\n * The unique identifier of the tax item.\n */\n taxitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/taxes/{taxitemID}\"\n}\n\nexport type UpdateATaxItemResponses = {\n 200: CartItemTaxesEntityResponse\n}\n\nexport type UpdateATaxItemResponse =\n UpdateATaxItemResponses[keyof UpdateATaxItemResponses]\n\nexport type BulkDeleteCustomDiscountsFromCartData = {\n body?: never\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts\"\n}\n\nexport type BulkDeleteCustomDiscountsFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type BulkDeleteCustomDiscountsFromCartResponse =\n BulkDeleteCustomDiscountsFromCartResponses[keyof BulkDeleteCustomDiscountsFromCartResponses]\n\nexport type BulkAddCustomDiscountsToCartData = {\n body?: CartsBulkCustomDiscounts\n path: {\n /**\n * Specifies the system generated ID for the cart that the shopper created.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts\"\n}\n\nexport type BulkAddCustomDiscountsToCartErrors = {\n /**\n * Could not apply custom discount\n */\n 400: ResponseErrorResponse\n /**\n * Could not apply custom discount\n */\n 422: ResponseErrorResponse\n}\n\nexport type BulkAddCustomDiscountsToCartError =\n BulkAddCustomDiscountsToCartErrors[keyof BulkAddCustomDiscountsToCartErrors]\n\nexport type BulkAddCustomDiscountsToCartResponses = {\n 201:\n | CartsBulkCustomDiscountsResponse\n | CartsBulkCustomDiscountsCollectionResponse\n}\n\nexport type BulkAddCustomDiscountsToCartResponse =\n BulkAddCustomDiscountsToCartResponses[keyof BulkAddCustomDiscountsToCartResponses]\n\nexport type DeleteCustomDiscountFromCartData = {\n body?: never\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the custom discount to be deleted.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type DeleteCustomDiscountFromCartResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomDiscountFromCartResponse =\n DeleteCustomDiscountFromCartResponses[keyof DeleteCustomDiscountFromCartResponses]\n\nexport type UpdateCustomDiscountForCartData = {\n body?: CartsCustomDiscountsEntityRequest\n path: {\n /**\n * Specifies the unique ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the custom discount to be updated.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type UpdateCustomDiscountForCartResponses = {\n 200: CartsCustomDiscountsEntityResponse\n}\n\nexport type UpdateCustomDiscountForCartResponse =\n UpdateCustomDiscountForCartResponses[keyof UpdateCustomDiscountForCartResponses]\n\nexport type AddCustomDiscountToCartItemData = {\n body?: CartsCustomDiscountsObject\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the unique identifier for the cart item.\n */\n cartitemID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts\"\n}\n\nexport type AddCustomDiscountToCartItemErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Bad Request\n */\n 422: ResponseErrorResponse\n}\n\nexport type AddCustomDiscountToCartItemError =\n AddCustomDiscountToCartItemErrors[keyof AddCustomDiscountToCartItemErrors]\n\nexport type AddCustomDiscountToCartItemResponses = {\n /**\n * Successful request\n */\n 201:\n | CartsCustomDiscountsCollectionResponse\n | CartsCustomDiscountsEntityResponse\n}\n\nexport type AddCustomDiscountToCartItemResponse =\n AddCustomDiscountToCartItemResponses[keyof AddCustomDiscountToCartItemResponses]\n\nexport type DeleteCustomDiscountFromCartItemData = {\n body?: never\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the cart item.\n */\n cartitemID: string\n /**\n * Specifies the ID for the custom discount to be deleted.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type DeleteCustomDiscountFromCartItemResponses = {\n /**\n * No Content\n */\n 204: void\n}\n\nexport type DeleteCustomDiscountFromCartItemResponse =\n DeleteCustomDiscountFromCartItemResponses[keyof DeleteCustomDiscountFromCartItemResponses]\n\nexport type UpdateCustomDiscountForCartItemData = {\n body?: CartsCustomDiscountsEntityRequest\n path: {\n /**\n * Specifies the ID for the cart.\n */\n cartID: string\n /**\n * Specifies the ID for the cart item.\n */\n cartitemID: string\n /**\n * Specifies the ID for the custom discount to be updated.\n */\n customdiscountID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}\"\n}\n\nexport type UpdateCustomDiscountForCartItemResponses = {\n 200: CartsCustomDiscountsEntityResponse\n}\n\nexport type UpdateCustomDiscountForCartItemResponse =\n UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses]\n\nexport type GetShippingGroupsData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/shipping-groups\"\n}\n\nexport type GetShippingGroupsErrors = {\n /**\n * Cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupsError =\n GetShippingGroupsErrors[keyof GetShippingGroupsErrors]\n\nexport type GetShippingGroupsResponses = {\n /**\n * A list of shipping groups\n */\n 200: {\n data?: Array<ShippingGroupResponse>\n }\n}\n\nexport type GetShippingGroupsResponse =\n GetShippingGroupsResponses[keyof GetShippingGroupsResponses]\n\nexport type CreateShippingGroupData = {\n body: CreateShippingGroupRequest\n path: {\n /**\n * The ID of the cart\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/shipping-groups\"\n}\n\nexport type CreateShippingGroupErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type CreateShippingGroupError =\n CreateShippingGroupErrors[keyof CreateShippingGroupErrors]\n\nexport type CreateShippingGroupResponses = {\n /**\n * Shipping group created successfully\n */\n 201: ShippingGroupResponse\n}\n\nexport type CreateShippingGroupResponse =\n CreateShippingGroupResponses[keyof CreateShippingGroupResponses]\n\nexport type DeleteCartShippingGroupData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group to delete\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type DeleteCartShippingGroupErrors = {\n /**\n * Cannot delete shipping group that is attached to cart items\n */\n 400: ResponseErrorResponse\n /**\n * Cart or shipping group not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type DeleteCartShippingGroupError =\n DeleteCartShippingGroupErrors[keyof DeleteCartShippingGroupErrors]\n\nexport type DeleteCartShippingGroupResponses = {\n /**\n * Successfully deleted the shipping group\n */\n 204: void\n}\n\nexport type DeleteCartShippingGroupResponse =\n DeleteCartShippingGroupResponses[keyof DeleteCartShippingGroupResponses]\n\nexport type GetShippingGroupByIdData = {\n body?: never\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type GetShippingGroupByIdErrors = {\n /**\n * Shipping group or cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupByIdError =\n GetShippingGroupByIdErrors[keyof GetShippingGroupByIdErrors]\n\nexport type GetShippingGroupByIdResponses = {\n /**\n * Shipping group details\n */\n 200: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type GetShippingGroupByIdResponse =\n GetShippingGroupByIdResponses[keyof GetShippingGroupByIdResponses]\n\nexport type UpdateShippingGroupData = {\n body: UpdateCartShippingGroupRequest\n path: {\n /**\n * The ID of the cart\n */\n cartId: string\n /**\n * The ID of the shipping group\n */\n shippingGroupId: string\n }\n query?: never\n url: \"/v2/carts/{cartId}/shipping-groups/{shippingGroupId}\"\n}\n\nexport type UpdateShippingGroupErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Shipping group or cart not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type UpdateShippingGroupError =\n UpdateShippingGroupErrors[keyof UpdateShippingGroupErrors]\n\nexport type UpdateShippingGroupResponses = {\n /**\n * Shipping group updated successfully\n */\n 200: ShippingGroupResponse\n}\n\nexport type UpdateShippingGroupResponse =\n UpdateShippingGroupResponses[keyof UpdateShippingGroupResponses]\n\nexport type CreateCartPaymentIntentData = {\n body?: ElasticPathPaymentsPoweredByStripePayment\n path: {\n /**\n * The universally unique identifier of the cart for which you want to create a payment intent.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/payments\"\n}\n\nexport type CreateCartPaymentIntentResponses = {\n /**\n * Payment Intent created successfully.\n */\n 201: CartResponse\n}\n\nexport type CreateCartPaymentIntentResponse =\n CreateCartPaymentIntentResponses[keyof CreateCartPaymentIntentResponses]\n\nexport type UpdateCartPaymentIntentData = {\n body: CartPaymentUpdate\n path: {\n /**\n * The unique identifier of the cart.\n */\n cartID: string\n /**\n * The unique identifier of the payment intent.\n */\n paymentIntentID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/payments/{paymentIntentID}\"\n}\n\nexport type UpdateCartPaymentIntentResponses = {\n /**\n * Payment updated successfully\n */\n 200: CartResponse\n}\n\nexport type UpdateCartPaymentIntentResponse =\n UpdateCartPaymentIntentResponses[keyof UpdateCartPaymentIntentResponses]\n\nexport type CheckoutApiData = {\n body?: CustomerCheckout | AccountCheckout\n headers?: {\n /**\n * An account management authentication token that identifies the authenticated account member.\n */\n \"EP-Account-Management-Authentication-Token\"?: string\n }\n path: {\n /**\n * The ID of the cart that you want to checkout.\n */\n cartID: string\n }\n query?: never\n url: \"/v2/carts/{cartID}/checkout\"\n}\n\nexport type CheckoutApiErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Internal Server Error\n */\n 500: ResponseErrorResponse\n}\n\nexport type CheckoutApiError = CheckoutApiErrors[keyof CheckoutApiErrors]\n\nexport type CheckoutApiResponses = {\n /**\n * OK\n */\n 201: OrderEntityResponse\n}\n\nexport type CheckoutApiResponse =\n CheckoutApiResponses[keyof CheckoutApiResponses]\n\nexport type GetCustomerOrdersData = {\n body?: never\n headers?: {\n /**\n * A customer token to access a specific customer's orders.\n */\n \"x-moltin-customer-token\"?: string\n }\n path?: never\n query?: never\n url: \"/v2/orders\"\n}\n\nexport type GetCustomerOrdersResponses = {\n 200: OrderCollectionResponse\n}\n\nexport type GetCustomerOrdersResponse =\n GetCustomerOrdersResponses[keyof GetCustomerOrdersResponses]\n\nexport type GetAnOrderData = {\n body?: never\n path: {\n /**\n * The ID of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}\"\n}\n\nexport type GetAnOrderErrors = {\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetAnOrderError = GetAnOrderErrors[keyof GetAnOrderErrors]\n\nexport type GetAnOrderResponses = {\n /**\n * OK\n */\n 200: OrderEntityResponse\n}\n\nexport type GetAnOrderResponse = GetAnOrderResponses[keyof GetAnOrderResponses]\n\nexport type UpdateAnOrderData = {\n body?: OrdersUpdateRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}\"\n}\n\nexport type UpdateAnOrderErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type UpdateAnOrderError = UpdateAnOrderErrors[keyof UpdateAnOrderErrors]\n\nexport type UpdateAnOrderResponses = {\n /**\n * OK\n */\n 200: OrderEntityResponse\n}\n\nexport type UpdateAnOrderResponse =\n UpdateAnOrderResponses[keyof UpdateAnOrderResponses]\n\nexport type GetOrderItemsData = {\n body?: never\n path: {\n /**\n * The ID of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/items\"\n}\n\nexport type GetOrderItemsResponses = {\n 200: OrderItemCollectionResponse\n}\n\nexport type GetOrderItemsResponse =\n GetOrderItemsResponses[keyof GetOrderItemsResponses]\n\nexport type AnonymizeOrdersData = {\n body?: OrdersAnonymizeRequest & unknown\n path?: never\n query?: never\n url: \"/v2/orders/anonymize\"\n}\n\nexport type AnonymizeOrdersErrors = {\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type AnonymizeOrdersError =\n AnonymizeOrdersErrors[keyof AnonymizeOrdersErrors]\n\nexport type AnonymizeOrdersResponses = {\n /**\n * OK\n */\n 200: OrdersListResponse\n}\n\nexport type AnonymizeOrdersResponse =\n AnonymizeOrdersResponses[keyof AnonymizeOrdersResponses]\n\nexport type ConfirmOrderData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order to confirm.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/confirm\"\n}\n\nexport type ConfirmOrderErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Not Found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type ConfirmOrderError = ConfirmOrderErrors[keyof ConfirmOrderErrors]\n\nexport type ConfirmOrderResponses = {\n /**\n * Order confirmed successfully\n */\n 200: OrderResponse\n}\n\nexport type ConfirmOrderResponse =\n ConfirmOrderResponses[keyof ConfirmOrderResponses]\n\nexport type PaymentSetupData = {\n body?: PaymentsRequest\n path: {\n /**\n * The Universally Unique Identifier (UUID) of the order you want to pay for.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/payments\"\n}\n\nexport type PaymentSetupErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Conflict\n */\n 409: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type PaymentSetupError = PaymentSetupErrors[keyof PaymentSetupErrors]\n\nexport type PaymentSetupResponses = {\n /**\n * OK\n */\n 200: TransactionEntityResponse\n}\n\nexport type PaymentSetupResponse =\n PaymentSetupResponses[keyof PaymentSetupResponses]\n\nexport type ConfirmPaymentData = {\n body?: OrdersTransactionsConfirmRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n /**\n * The unique identifier of the transaction.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/confirm\"\n}\n\nexport type ConfirmPaymentErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type ConfirmPaymentError =\n ConfirmPaymentErrors[keyof ConfirmPaymentErrors]\n\nexport type ConfirmPaymentResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type ConfirmPaymentResponse =\n ConfirmPaymentResponses[keyof ConfirmPaymentResponses]\n\nexport type CaptureATransactionData = {\n body?: OrdersTransactionsCaptureRequest\n path: {\n /**\n * The UUID of the order.\n */\n orderID: string\n /**\n * The UUID of the transaction to capture.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/capture\"\n}\n\nexport type CaptureATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type CaptureATransactionError =\n CaptureATransactionErrors[keyof CaptureATransactionErrors]\n\nexport type CaptureATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type CaptureATransactionResponse =\n CaptureATransactionResponses[keyof CaptureATransactionResponses]\n\nexport type RefundATransactionData = {\n body?: OrdersTransactionsRefundRequest\n path: {\n /**\n * The UUID of the order.\n */\n orderID: string\n /**\n * The UUID of the transaction you want to refund.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/refund\"\n}\n\nexport type RefundATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type RefundATransactionError =\n RefundATransactionErrors[keyof RefundATransactionErrors]\n\nexport type RefundATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type RefundATransactionResponse =\n RefundATransactionResponses[keyof RefundATransactionResponses]\n\nexport type GetOrderTransactionsData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions\"\n}\n\nexport type GetOrderTransactionsErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type GetOrderTransactionsError =\n GetOrderTransactionsErrors[keyof GetOrderTransactionsErrors]\n\nexport type GetOrderTransactionsResponses = {\n 200: TransactionListResponse\n}\n\nexport type GetOrderTransactionsResponse =\n GetOrderTransactionsResponses[keyof GetOrderTransactionsResponses]\n\nexport type GetATransactionData = {\n body?: never\n path: {\n /**\n * The unique identifier of the order that you require transactions for.\n */\n orderID: string\n /**\n * The unique identifier of the transaction.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}\"\n}\n\nexport type GetATransactionResponses = {\n 200: ResponseData & {\n data?: TransactionResponse\n }\n}\n\nexport type GetATransactionResponse =\n GetATransactionResponses[keyof GetATransactionResponses]\n\nexport type CancelATransactionData = {\n body?: OrdersTransactionsCancelRequest\n path: {\n /**\n * The unique identifier of the order.\n */\n orderID: string\n /**\n * The unique identifier of the transaction to be canceled or voided.\n */\n transactionID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/transactions/{transactionID}/cancel\"\n}\n\nexport type CancelATransactionErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n}\n\nexport type CancelATransactionError =\n CancelATransactionErrors[keyof CancelATransactionErrors]\n\nexport type CancelATransactionResponses = {\n 200: TransactionEntityResponse\n}\n\nexport type CancelATransactionResponse =\n CancelATransactionResponses[keyof CancelATransactionResponses]\n\nexport type GetOrderShippingGroupsData = {\n body?: never\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups\"\n}\n\nexport type GetOrderShippingGroupsErrors = {\n /**\n * Order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetOrderShippingGroupsError =\n GetOrderShippingGroupsErrors[keyof GetOrderShippingGroupsErrors]\n\nexport type GetOrderShippingGroupsResponses = {\n /**\n * A list of shipping groups\n */\n 200: {\n data?: Array<ShippingGroupResponse>\n }\n}\n\nexport type GetOrderShippingGroupsResponse =\n GetOrderShippingGroupsResponses[keyof GetOrderShippingGroupsResponses]\n\nexport type CreateOrderShippingGroupData = {\n /**\n * Shipping group details\n */\n body?: {\n data?: {\n type: \"shipping_group\"\n /**\n * The shipping type for this group\n */\n shipping_type?: string\n /**\n * Tracking reference for the shipment\n */\n tracking_reference?: string\n address?: {\n first_name?: string\n last_name?: string\n phone_number?: string\n company_name?: string\n line_1?: string\n line_2?: string\n city?: string\n postcode?: string\n county?: string\n country?: string\n region?: string\n instructions?: string\n }\n delivery_estimate?: {\n start?: Date\n end?: Date\n }\n }\n }\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups\"\n}\n\nexport type CreateOrderShippingGroupErrors = {\n /**\n * Bad Request\n */\n 400: ResponseErrorResponse\n /**\n * Order not found\n */\n 404: ResponseErrorResponse\n /**\n * Unprocessable Entity\n */\n 422: ResponseErrorResponse\n}\n\nexport type CreateOrderShippingGroupError =\n CreateOrderShippingGroupErrors[keyof CreateOrderShippingGroupErrors]\n\nexport type CreateOrderShippingGroupResponses = {\n /**\n * Shipping group created\n */\n 201: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type CreateOrderShippingGroupResponse =\n CreateOrderShippingGroupResponses[keyof CreateOrderShippingGroupResponses]\n\nexport type GetShippingGroupsByIdData = {\n body?: never\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n /**\n * The ID of the shipping group\n */\n shippingGroupID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups/{shippingGroupID}\"\n}\n\nexport type GetShippingGroupsByIdErrors = {\n /**\n * Shipping group or order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type GetShippingGroupsByIdError =\n GetShippingGroupsByIdErrors[keyof GetShippingGroupsByIdErrors]\n\nexport type GetShippingGroupsByIdResponses = {\n /**\n * Shipping group details\n */\n 200: {\n data?: ShippingGroupResponse\n }\n}\n\nexport type GetShippingGroupsByIdResponse =\n GetShippingGroupsByIdResponses[keyof GetShippingGroupsByIdResponses]\n\nexport type PutShippingGroupByIdData = {\n body: UpdateOrderShippingGroupRequest\n path: {\n /**\n * The ID of the order\n */\n orderID: string\n /**\n * The ID of the shipping group\n */\n shippingGroupID: string\n }\n query?: never\n url: \"/v2/orders/{orderID}/shipping-groups/{shippingGroupID}\"\n}\n\nexport type PutShippingGroupByIdErrors = {\n /**\n * Invalid request\n */\n 400: ResponseErrorResponse\n /**\n * Shipping group or order not found\n */\n 404: ResponseErrorResponse\n}\n\nexport type PutShippingGroupByIdError =\n PutShippingGroupByIdErrors[keyof PutShippingGroupByIdErrors]\n\nexport type PutShippingGroupByIdResponses = {\n /**\n * Shipping group updated successfully\n */\n 200: ShippingGroupResponse\n}\n\nexport type PutShippingGroupByIdResponse =\n PutShippingGroupByIdResponses[keyof PutShippingGroupByIdResponses]\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
|
@@ -964,6 +964,10 @@ type ShippingGroupResponse = {
|
|
|
964
964
|
order_id?: string;
|
|
965
965
|
shipping_type?: string;
|
|
966
966
|
tracking_reference?: string;
|
|
967
|
+
/**
|
|
968
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
|
|
969
|
+
*/
|
|
970
|
+
external_ref?: string;
|
|
967
971
|
address?: ShippingAddress;
|
|
968
972
|
delivery_estimate?: DeliveryEstimate;
|
|
969
973
|
createdAt?: Date;
|
|
@@ -987,6 +991,10 @@ type CreateShippingGroupRequest = {
|
|
|
987
991
|
type?: "shipping_group";
|
|
988
992
|
shipping_type?: string;
|
|
989
993
|
tracking_reference?: string;
|
|
994
|
+
/**
|
|
995
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
996
|
+
*/
|
|
997
|
+
external_ref?: string;
|
|
990
998
|
shipping_price?: ShippingPriceRequest;
|
|
991
999
|
address?: ShippingAddress;
|
|
992
1000
|
includes_tax?: boolean;
|
|
@@ -998,6 +1006,10 @@ type UpdateCartShippingGroupRequest = {
|
|
|
998
1006
|
type?: "shipping_group";
|
|
999
1007
|
shipping_type?: string;
|
|
1000
1008
|
tracking_reference?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
1011
|
+
*/
|
|
1012
|
+
external_ref?: string;
|
|
1001
1013
|
shipping_price?: ShippingPriceRequest;
|
|
1002
1014
|
address?: ShippingAddress;
|
|
1003
1015
|
includes_tax?: boolean;
|
|
@@ -1770,6 +1782,10 @@ type UpdateOrderShippingGroupRequest = {
|
|
|
1770
1782
|
type?: "shipping_group";
|
|
1771
1783
|
shipping_type?: string;
|
|
1772
1784
|
tracking_reference?: string;
|
|
1785
|
+
/**
|
|
1786
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
1787
|
+
*/
|
|
1788
|
+
external_ref?: string;
|
|
1773
1789
|
address?: ShippingAddress;
|
|
1774
1790
|
delivery_estimate?: DeliveryEstimate;
|
|
1775
1791
|
};
|
|
@@ -964,6 +964,10 @@ type ShippingGroupResponse = {
|
|
|
964
964
|
order_id?: string;
|
|
965
965
|
shipping_type?: string;
|
|
966
966
|
tracking_reference?: string;
|
|
967
|
+
/**
|
|
968
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
|
|
969
|
+
*/
|
|
970
|
+
external_ref?: string;
|
|
967
971
|
address?: ShippingAddress;
|
|
968
972
|
delivery_estimate?: DeliveryEstimate;
|
|
969
973
|
createdAt?: Date;
|
|
@@ -987,6 +991,10 @@ type CreateShippingGroupRequest = {
|
|
|
987
991
|
type?: "shipping_group";
|
|
988
992
|
shipping_type?: string;
|
|
989
993
|
tracking_reference?: string;
|
|
994
|
+
/**
|
|
995
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
996
|
+
*/
|
|
997
|
+
external_ref?: string;
|
|
990
998
|
shipping_price?: ShippingPriceRequest;
|
|
991
999
|
address?: ShippingAddress;
|
|
992
1000
|
includes_tax?: boolean;
|
|
@@ -998,6 +1006,10 @@ type UpdateCartShippingGroupRequest = {
|
|
|
998
1006
|
type?: "shipping_group";
|
|
999
1007
|
shipping_type?: string;
|
|
1000
1008
|
tracking_reference?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
1011
|
+
*/
|
|
1012
|
+
external_ref?: string;
|
|
1001
1013
|
shipping_price?: ShippingPriceRequest;
|
|
1002
1014
|
address?: ShippingAddress;
|
|
1003
1015
|
includes_tax?: boolean;
|
|
@@ -1770,6 +1782,10 @@ type UpdateOrderShippingGroupRequest = {
|
|
|
1770
1782
|
type?: "shipping_group";
|
|
1771
1783
|
shipping_type?: string;
|
|
1772
1784
|
tracking_reference?: string;
|
|
1785
|
+
/**
|
|
1786
|
+
* An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters.
|
|
1787
|
+
*/
|
|
1788
|
+
external_ref?: string;
|
|
1773
1789
|
address?: ShippingAddress;
|
|
1774
1790
|
delivery_estimate?: DeliveryEstimate;
|
|
1775
1791
|
};
|