/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/checkouts/{checkoutId}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Get a Checkout * @description Returns a *Checkout*. * * The cart ID and checkout ID are the same. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly get: operations["getCheckout"]; /** * Update Customer Messages * @description Updates *Checkout* customer messages. * * **Limits** * * * 2000 character limit * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly put: operations["updateCheckout"]; }; readonly "/checkouts/{checkoutId}/carts/{cartId}/items/{itemId}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the cart associated with this checkout. Identical to the checkout ID. */ readonly cartId: components["parameters"]["CartIdPath"]; /** @description The ID of an item being purchased. */ readonly itemId: components["parameters"]["ItemIdPath"]; }; readonly cookie?: never; }; /** * Update a Line Item * @description Updates a *Checkout Line Item*. Updates an existing, single line item in the cart. * * If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). * * > #### Notes * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly put: operations["updateCheckoutLineItem"]; /** * Delete a Line Item * @description Deletes a *Line Item* from the *Cart*. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly delete: operations["deleteCheckoutLineItem"]; }; readonly "/checkouts/{checkoutId}/billing-address": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Add Checkout Billing Address * @description Adds a billing address to an existing *Checkout*. * * **Required Fields** * * country_code * * * > #### Note * > * The `email` property is only required if the customer is a guest shopper. Otherwise, it is set automatically. * > * Sending `email` property as a payload in POST request triggers the abandoned cart notification process. * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly post: operations["addCheckoutBillingAddress"]; }; readonly "/checkouts/{checkoutId}/billing-address/{addressId}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the subject address. */ readonly addressId: components["parameters"]["AddressIdPath"]; }; readonly cookie?: never; }; /** * Update Checkout Billing Address * @description Updates an existing billing address on *Checkout*. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly put: operations["updateCheckoutBillingAddress"]; }; readonly "/checkouts/{checkoutId}/consignments": { readonly parameters: { readonly query?: { /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Create a Consignment * @description Adds a new *Consignment* to *Checkout*. * * Perform the following two steps to define the fulfillment of the items in the cart. * * ### For shipping consignments: * * 1. Add a new Consignment to Checkout. * * * Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs. * * Provide a full valid customer address before placing the order. If provided, the order placement will succeed. * * As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response. * * * Required Fields: * * `shipping_address` (deprecated) or `address` * * `lineItems` * * 2. Update the Consignment with Shipping Options using the [REST Storefront API](/docs/rest-storefront/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront). * * ### For pickup consignments: * * Create a new consignment object. * * - Send a `POST` request to `/consignments` with line item IDs and quantities. * - Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API. * - Required Fields: * * `pickupOption` * * `lineItems` * * To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/docs/storefront/cart-checkout/guide/rest-storefront). * * > #### Notes * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. * */ readonly post: operations["createCheckoutConsignment"]; }; readonly "/checkouts/{checkoutId}/consignments/{consignmentId}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the subject consignment. */ readonly consignmentId: components["parameters"]["ConsignmentIdPath"]; }; readonly cookie?: never; }; /** * Update a Consignment * @description Updates an existing consignment. An update is either one of the following: * * 1. Updates the consignment address and/or line items. * 2. Selects a specific fulfillment option. * * ### Update the consignment address and line items * For this type of update, the payload is the same as when creating a new consignment. Update each *Consignment* `shippingOptionId` (shipping address and line items) with the `availableShippingOption > id` from the POST `/consignment` response. * * **Note:** * Updating a consignment could invalidate the value for `selectedShippingOption` and `selectedPickupOption`. * * ### Select a specific fulfillment option * Before placing an order, each consignment must have a `selectedShippingOption` or a `selectedPickupOption`. * * If the consignment already has a pick-up option selected and a shipping option is provided, the pick-up option will be deselected and the shipping option will be selected instead (and vice versa). The `PUT` request will fail if it contains a shipping option ID and a pickup option ID. * * Required Fields: * * `shippingOptionId` or `pickupOptionId` * * `lineItems` * * To learn more about creating a Checkout Consignment see [Checkout Consignment API](/docs/storefront/cart-checkout/guide/consignments). * * > #### Notes * > * You cannot pass both an `address` and a `shippingOptionId` because the shipping option may not be available for the new address * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly put: operations["updateCheckoutConsignment"]; /** * Delete a Consignment * @description Removes an existing *Consignment* from *Checkout*. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly delete: operations["deleteCheckoutConsignment"]; }; readonly "/checkouts/{checkoutId}/gift-certificates": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Add Gift Certificate to Checkout * @description Adds a *Gift Certificate Code* to *Checkout*. * * > #### Note * > * *Gift Certificates* are treated as a payment methods. * > * You are not able to purchase a gift certificate with a gift certificate. * > * The rate limit is 20/hour (only for unique gift-certificate codes). * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly post: operations["addCheckoutGiftCertificate"]; }; readonly "/checkouts/{checkoutId}/gift-certificates/{giftCertificateCode}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The code of the subject gift certificate. */ readonly giftCertificateCode: components["parameters"]["GiftCertificateCodePath"]; }; readonly cookie?: never; }; /** * Delete Gift Certificate * @description Deletes an existing *Gift Certificate*. * * This removes the *Gift Certificate* payment method. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly delete: operations["deleteCheckoutGiftCertificate"]; }; readonly "/checkouts/{checkoutId}/coupons": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Add Coupon to Checkout * @description Adds a *Coupon Code* to *Checkout*. * * **Required Fields** * * couponCode * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly post: operations["addCheckoutCoupon"]; }; readonly "/checkouts/{checkoutId}/coupons/{couponCode}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The code of the subject coupon. */ readonly couponCode: components["parameters"]["CouponCodePath"]; }; readonly cookie?: never; }; /** * Delete Checkout Coupon * @description Deletes a *Coupon Code* from *Checkout*. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. * */ readonly delete: operations["deleteCheckoutCoupon"]; }; readonly "/checkouts/{checkoutId}/store-credit": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Add Store Credit * @description Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly post: operations["addCheckoutStoreCredit"]; /** * Remove Store Credit * @description Removes store credit from a checkout. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly delete: operations["removeCheckoutStoreCredit"]; }; readonly "/checkouts/{checkoutId}/spam-protection": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; /** * Checkout Spam Protection * @description Verifies if checkout is created by human. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * > * The Send a Test Request feature is not currently supported for this endpoint. * > * This endpoint requires using Stencil CLI, a local session, and a csrf token to work. */ readonly post: operations["checkoutSpamProtection"]; }; } export type webhooks = Record; export interface components { schemas: { /** SpamProtectionRequest */ readonly SpamProtectionRequest: { readonly token?: string; }; /** checkout_Full */ readonly checkout_Full: { readonly billingAddress?: components["schemas"]["address_Base"]; readonly cart?: components["schemas"]["checkoutCart"]; /** @description Channel ID. */ readonly channelId?: number; readonly consignments?: readonly components["schemas"]["consignment_Full"][]; /** @description Coupons applied at the checkout level. */ readonly coupons?: readonly components["schemas"]["CheckoutCoupon"][]; /** @description Fees applied at the checkout level. */ readonly fees?: readonly components["schemas"]["CheckoutFee"][]; /** @description Time when the cart was created. */ readonly createdTime?: string; readonly customer?: components["schemas"]["Customer"]; /** @description Shopperʼs message provided as details for the order to be created from this cart */ readonly customerMessage?: string; /** @description Applied gift certificate (as a payment method). */ readonly giftCertificates?: readonly components["schemas"]["checkoutGiftCertificates"][]; /** @description Gift wrapping cost for all items, including or excluding tax. */ readonly giftWrappingCostTotal?: number; /** * Format: float * @description The total payable amount, before applying any store credit or gift certificate. */ readonly grandTotal?: number; /** * Format: float * @description Handling cost for all consignments including or excluding tax. */ readonly handlingCostTotal?: number; /** Format: uuid */ readonly id?: string; /** @description `true` value indicates StoreCredit has been applied. * */ readonly isStoreCreditApplied?: boolean; readonly orderId?: string | null; /** @description `grandTotal` subtract the store-credit amount * */ readonly outstandingBalance?: number; readonly payments?: readonly { /** @description Payment provider ID. */ readonly providerId?: string; /** @description Payment gateway ID. */ readonly gatewayId?: string | null; /** * @description Type of payment provider. * @enum {string} */ readonly providerType?: "PAYMENT_TYPE_HOSTED"; /** @description Details regarding which checkout steps a shopper has completed. */ readonly detail?: readonly ("FINALIZE" | "INITIALIZE" | "ACKNOWLEDGE")[]; }[]; readonly promotions?: readonly { /** @enum {string} */ readonly type?: "promotion" | "upsell" | "eligible" | "applied"; /** @description Text displayed on the storefront for the promotion. */ readonly text?: string; }[]; /** @description The shipping cost before discounts are applied. */ readonly shippingCostBeforeDiscount?: number; /** * Format: float * @description Shipping cost before any discounts are applied. */ readonly shippingCostTotal?: number; readonly shouldExecuteSpamCheck?: boolean; /** * Format: float * @description Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings. */ readonly subtotal?: number; readonly taxes?: readonly components["schemas"]["checkoutTax"][]; /** Format: float */ readonly taxTotal?: number; /** @description Time when the cart was last updated. */ readonly updatedTime?: string; /** * @description The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates. * @example 1 */ readonly version?: number; }; /** Cart Coupon */ readonly CartCoupon: { /** @description The coupon ID. */ readonly id?: number; /** @description the coupon code */ readonly code: string; /** @description The coupon name displayed on the storefront. */ readonly displayName?: string; /** * @description Key name to identify the type of coupon. * @enum {string} */ readonly couponType?: "per_item_discount" | "percentage_discount" | "per_total_discount" | "shipping_discount" | "free_shipping" | "promotion"; /** * Format: double * @description The discounted amount applied within a given context. */ readonly discountedAmount?: number; }; /** Checkout Coupon */ readonly CheckoutCoupon: { /** @description The coupon ID. */ readonly id?: number; /** @description the coupon code */ readonly code: string; /** @description The coupon name displayed on the storefront. */ readonly displayName?: string; /** @description |Type `int`|Type Name| * |-|-| * |`0`|`per_item_discount`| * |`1`|`percentage_discount`| * |`2`|`per_total_discount`| * |`3`|`shipping_discount`| * |`4`|`free_shipping`| * |`5`|`promotion`| */ readonly couponType?: number; /** * Format: double * @description The discounted amount applied within a given context. */ readonly discountedAmount?: number; }; /** Checkout Fee */ readonly CheckoutFee: { /** * Format: uuid * @description The fee ID. * @example 497f6eca-6276-4993-bfeb-53cbbbba6f08 */ readonly id?: string; /** * @description The type of the fee. * @enum {string} */ readonly type?: "custom_fee"; /** * @description Name of the fee. * @example AAINS */ readonly name?: string; /** * @description Display name of the fee targeting customers/shoppers. * @example Package Protection Insurance */ readonly displayName?: string; /** * @description Cost of the fee (include or exclude tax dependent on tax settings, same as shipping cost). * @example 10 */ readonly cost?: number; /** * @description The source of the request. * @example AA */ readonly source?: string; /** * @description The tax class ID. * @example 1 */ readonly taxClassId?: number; }; /** @description Customer details. */ readonly Customer: { readonly addresses?: readonly { readonly id?: number; readonly firstName?: string; readonly lastName?: string; readonly company?: string; readonly address1?: string; readonly address2?: string; readonly city?: string; /** @description State or province. */ readonly stateOrProvince?: string; readonly stateOrProvinceCode?: string; /** @description [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the country. */ readonly countryCode?: string; readonly postalCode?: string; readonly phone?: string; /** @description Address type. */ readonly type?: string; readonly customFields?: readonly components["schemas"]["customFields"][]; }[]; readonly customerGroup?: { /** @description ID of the customer group. */ readonly id?: number; /** @description Name of the customer group. */ readonly name?: string; }; /** @description Customer email. */ readonly email?: string; /** @description Customer's first name. */ readonly firstName?: string; /** @description Customer's full name. */ readonly fullName?: string; /** @description Customer ID. */ readonly id?: number; /** @description Whether the shopper is a guest or a logged-in customer. */ readonly isGuest?: boolean; /** @description Customer's last name. */ readonly lastName?: string; readonly shouldEncourageSignIn?: boolean; /** @description The amount of store credit a customer has. */ readonly storeCredit?: number; }; /** * contactEntity * @description Model for sender and receiver objects. */ readonly contactEntity: { readonly name?: string; readonly email?: string; }; /** address_Full */ readonly address_Full: components["schemas"]["address_Base"] & { readonly id?: string; /** @description Indicates whether we should add this address to the customer address book. */ readonly shouldSaveAddress?: boolean; }; /** address_Base */ readonly address_Base: { readonly address1?: string; readonly address2?: string; readonly city?: string; readonly company?: string; /** @description Country name. */ readonly country?: string; /** @description ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) */ readonly countryCode: string; readonly customFields?: readonly components["schemas"]["customFields"][]; readonly email?: string; readonly firstName?: string; readonly lastName?: string; /** @description Represents state or province. */ readonly stateOrProvince?: string; readonly stateOrProvinceCode?: string; readonly phone?: string; readonly postalCode?: string; }; /** * customFields * @description When doing a PUT or POST to the `fieldValue` with a pick list, the input must be a number. The response will be a string. */ readonly customFields: { readonly fieldId?: string; /** @description This can also be an array for fields that need to support list of values; for example, a set of checkboxes. When doing a PUT or POST to the `fieldValue` with a pick list, the input must be a number. The response will be a string. */ readonly fieldValue?: string; }; /** Billing address request */ readonly BillingAddressRequest: components["schemas"]["address_Base"] & { /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** * consignment_Full * @description This allows us to have multiple shipping addresses. Where there is only one shipping address, this array will contain only one value, with all the items. */ readonly consignment_Full: { readonly address?: components["schemas"]["address_Full"]; /** @description This is available only when "include=consignments.availableShippingOptions" is present in the URL. */ readonly availableShippingOptions?: readonly components["schemas"]["consignmentAvailableShippingOptions"][]; /** @description List of consignment discounts applied through coupons. */ readonly couponDiscounts?: readonly { /** Format: double */ readonly amount?: number; /** @description Coupon code that applied this discount. */ readonly code?: string; }[]; /** @description List of consignment discounts applied through cart level discounts. */ readonly discounts?: readonly { /** @description Discount rule ID that applied this discount. */ readonly id?: string; }[]; /** * Format: double * @description The handling cost of shipping for this consignment. */ readonly handlingCost?: number; readonly id?: string; readonly selectedPickupOption?: components["schemas"]["PickupOption"]; /** Selected Shipping Option */ readonly selectedShippingOption?: { /** @description Read only. */ readonly description?: string; readonly id?: string; /** @description Specifies the type of shipping option; for example, flat rate, UPS, etc. */ readonly type?: string; readonly imageUrl?: string; /** Format: double */ readonly cost?: number; /** @description An estimate of the arrival time. */ readonly transitTime?: string; /** @description Read only. Field used for Shipping Provider API. */ readonly additionalDescription?: string; }; /** * @deprecated * @description Use the `address` field instead. */ readonly shippingAddress?: Record; /** * Format: double * @description The shipping cost for this consignment. */ readonly shippingCost?: number; readonly lineItemIds?: readonly string[]; }; /** consignmentAvailableShippingOptions */ readonly consignmentAvailableShippingOptions: components["schemas"]["consignmentShippingOption_Base"] & { /** @description Is this shipping method the recommended shipping option or not. */ readonly isRecommended?: boolean; readonly additionalDescription?: string; }; /** checkoutTax */ readonly checkoutTax: { /** @description Name of the tax. */ readonly name?: string; /** Format: double */ readonly amount?: number; }; /** checkout_Put */ readonly checkout_Put: { readonly customerMessage?: string; /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** cartLineItemPut */ readonly cartLineItemPut: { /** Format: double */ readonly quantity?: number; /** Format: double */ readonly productId?: number; /** Format: double */ readonly variantId?: number; readonly giftWrapping?: components["schemas"]["cartLineItemGiftWrapping_Put"]; }; /** cartLineItemGiftCertificate_Put */ readonly cartLineItemGiftCertificate_Put: { /** @description Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`. */ readonly theme: string; /** Format: double */ readonly amount: number; readonly sender: components["schemas"]["contactEntity"]; readonly recipient: components["schemas"]["contactEntity"]; /** @description Message shown to recipient, as provided by sender. */ readonly message?: string; /** Format: double */ readonly quantity: number; }; /** * Gift Wrapping Request Data * @description if passing null, it will remove the current gift wrapping for the item */ readonly cartLineItemGiftWrapping_Put: { /** * @description Boolean value that specifies whether items whether items should be wrapped together or wrapped individually. * @example true */ readonly wrapTogether: boolean; /** @description Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value. * If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. * (e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping) * If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped */ readonly wrapDetails: readonly { /** * @description Identifier of the gift wrapping option selected. * @example 0 */ readonly id: number; /** * @description Custom gift message. * @example Happy Birthday */ readonly message?: string; }[]; } | null; /** Create Consignment Request */ readonly CreateConsignmentRequest: { readonly shippingAddress?: Record; /** Address Properties */ readonly address?: { readonly firstName?: string; readonly lastName?: string; readonly email?: string; readonly company?: string; readonly address1?: string; readonly address2?: string; readonly city?: string; /** @description Represents state or province. */ readonly stateOrProvince?: string; readonly stateOrProvinceCode?: string; /** @description ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) */ readonly countryCode: string; readonly postalCode?: string; readonly phone?: string; readonly customFields?: readonly { readonly fieldId?: string; readonly fieldValue?: string; }[]; /** @description Indicates whether we should add this address to the customer address book. */ readonly shouldSaveAddress?: boolean; }; readonly lineItems?: readonly { /** @description The ID of a line item. */ readonly itemId: string; /** * Format: int32 * @description The quantity of the line item. */ readonly quantity: number; }[]; readonly shippingOptionId?: string; readonly pickupOption?: { readonly pickupMethodId?: number; }; /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** Delete Coupon Request */ readonly DeleteCouponCodeRequest: { /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** Delete Consignment Request */ readonly DeleteConsignmentRequest: { /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** Gift Certificate Request */ readonly GiftCertificateRequest: { readonly giftCertificateCode?: string; }; /** cart_Put */ readonly cart_Put: { readonly lineItem?: components["schemas"]["cartLineItemPut"]; readonly giftCertificate?: components["schemas"]["cartLineItemGiftCertificate_Put"]; }; /** * Update Consignment Request * @description One or more of these three fields is mandatory. You can update address and line items in one request. You have to update shipping option ID or pickup option ID in a separate request since changing the address or line items can invalidate the previously available shipping options. */ readonly NewUpdateConsignment: { readonly shippingAddress?: Record; /** Address Properties */ readonly address?: { readonly firstName?: string; readonly lastName?: string; readonly email?: string; readonly company?: string; readonly address1?: string; readonly address2?: string; readonly city?: string; /** @description Represents state or province. */ readonly stateOrProvince?: string; readonly stateOrProvinceCode?: string; /** @description ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) */ readonly countryCode: string; readonly postalCode?: string; readonly phone?: string; readonly customFields?: readonly { readonly fieldId?: string; readonly fieldValue?: string; }[]; /** @description Indicates whether we should add this address to the customer address book. */ readonly shouldSaveAddress?: boolean; }; readonly lineItems?: readonly { /** @description The ID of a line item. */ readonly itemId: string; /** * Format: int32 * @description The quantity of a line item. */ readonly quantity: number; }[]; readonly shippingOptionId?: string; readonly pickupOption?: { readonly pickupMethodId?: number; }; /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; /** * checkoutCart * @description A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. */ readonly checkoutCart: { /** * Format: double * @description Cost of cart’s contents, before applying discounts. */ readonly baseAmount?: number; /** * Format: double * @description Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes, where applicable. */ readonly cartAmount?: number; /** @description Time when the cart was created. */ readonly createdTime?: string; readonly coupons?: readonly components["schemas"]["CartCoupon"][]; /** * Currency * @description The currency in which prices are displayed; the store default currency. */ readonly currency?: { /** @description ISO-4217 currency code. (See: https://www.iso.org/iso-4217-currency-codes.html.) */ readonly code?: string; /** * Format: double * @description The number of decimal places for the currency. For example, the USD currency has two decimal places. */ readonly decimalPlaces?: number; /** @description The currency name. */ readonly name?: string; /** @description The currency symbol. */ readonly symbol?: string; }; /** * Format: int32 * @description ID of the customer to which the cart belongs. */ readonly customerId?: number; /** * Format: double * @description Order-based discounted amount only - Excludes coupon discounts and product-based discounts. */ readonly discountAmount?: number; readonly discounts?: readonly { /** @description Discount ID. */ readonly id?: number; /** * Format: double * @description The discounted amount applied within a given context. */ readonly discountedAmount?: number; }[]; /** @description The cartʼs email. This is the same email that is used in the billing address. */ readonly email?: string; /** * Format: uuid * @description Cart ID, provided after creating a cart with a POST. */ readonly id?: string; /** @description Boolean representing whether tax information is included. */ readonly isTaxIncluded?: boolean; /** Line Items */ readonly lineItems?: { readonly customItems?: readonly { /** @description ID of the custom item. */ readonly id?: string; /** @description The net item price before discounts and coupons. BigCommerce derives an item's list price from the product default price or, if applicable, the sale price configured in the admin panel. */ readonly listPrice?: string; /** @description Item name. */ readonly name?: string; readonly quantity?: string; /** @description Custom item SKU. */ readonly sku?: string; }[]; readonly digitalItems: readonly components["schemas"]["lineItemPhysicalDigital"][]; readonly giftCertificates?: readonly { /** * Format: double * @description Value must be between $1.00 and $1,000.00. */ readonly amount: number; /** @description Gift certificate identifier */ readonly id?: string; /** @description Limited to 200 characters. */ readonly message?: string; /** @description The name of the purchased gift certificate; for example, `$20 Gift Certificate`. */ readonly name?: string; /** Contact Entity */ readonly recipient: { readonly name?: string; readonly email?: string; }; /** Contact Entity */ readonly sender: { readonly name?: string; readonly email?: string; }; readonly taxable?: boolean; /** @description Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`. */ readonly theme: string; /** @description Explicitly specifying the gift certificate type. */ readonly type?: string; }[]; readonly physicalItems: readonly components["schemas"]["lineItemPhysicalDigital"][]; }; /** * @description Shopper's locale. * @example en */ readonly locale?: string; /** @description Time when the cart was last updated. */ readonly updatedTime?: string; /** @description Cart version. */ readonly version?: number; }; readonly lineItemPhysicalDigital: { /** @description If the item was added automatically by a promotion, such as a coupon or buy one, get one. */ readonly addedByPromotion?: boolean; readonly categoryNames?: readonly string[]; /** @description The itemʼs comparison price */ readonly comparisonPrice?: number; /** * Format: double * @description The total value of all coupons applied to this item. */ readonly couponAmount?: number; /** @description A list of discounts applied to this item, as an array of AppliedDiscount objects. */ readonly discounts?: readonly { /** @description Discount ID. */ readonly id?: number; /** * Format: double * @description The discounted amount applied within a given context. */ readonly discountedAmount?: number; }[]; /** * Format: double * @description The total value of all discounts applied to this item (excluding coupon). */ readonly discountAmount?: number; /** @description The itemʼs comparison price multiplied by the quantity. */ readonly extendedComparisonPrice?: number; /** * Format: double * @description The itemʼs list price multiplied by the quantity. */ readonly extendedListPrice?: number; /** * Format: double * @description The itemʼs sale price multiplied by the quantity. */ readonly extendedSalePrice?: number; /** Gift Wrapping */ readonly giftWrapping?: { readonly name?: string; readonly message?: string; /** Format: double */ readonly amount?: number; }; /** @description The line-item ID. */ readonly id?: string; /** @description A publicly-accessible URL for an image of this item. */ readonly imageUrl?: string; readonly isMutable?: boolean; /** @description Whether this item requires shipping to a physical address. */ readonly isShippingRequired?: boolean; /** @description Whether the item is taxable. */ readonly isTaxable?: boolean; /** * Format: double * @description The net item price before discounts and coupons. BigCommerce derives an item's list price from the product default price or, if applicable, the sale price configured in the admin panel. */ readonly listPrice?: number; /** @description The itemʼs product name. */ readonly name?: string; readonly options?: readonly { /** @description Option name. */ readonly name?: string; /** @description Option ID. */ readonly nameId?: number; /** @description Option value. */ readonly value?: string; /** @description Option value ID. */ readonly valueId?: string; }[]; /** @description The item’s original price is the same as the product’s default price. */ readonly originalPrice?: number; /** @description The product is part of a bundle such as a product pick list, then the parentId or the main product ID will populate. */ readonly parentId?: string; /** @description ID of the product. */ readonly productId?: number; /** @description SKU of the variant. */ readonly sku?: string; /** * Format: double * @description Quantity of this item. */ readonly quantity: number; /** * Format: double * @description The itemʼs price after all discounts are applied. The final price before tax calculation. */ readonly salePrice?: number; /** @description the product type - physical or digital */ readonly type?: string; /** @description The product URL. */ readonly url?: string; /** @description ID of the variant. */ readonly variantId?: number; }; /** * checkoutGiftCertificates * @description Applied gift certificate (as a payment method). */ readonly checkoutGiftCertificates: { /** Format: double */ readonly balance?: number; readonly code?: string; /** Format: date */ readonly purchaseDate?: string; /** Format: double */ readonly remaining?: number; /** Format: double */ readonly used?: number; }; /** consignmentShippingOption_Base */ readonly consignmentShippingOption_Base: { /** Format: double */ readonly cost?: number; /** @description Read only. */ readonly description?: string; readonly id?: string; readonly imageUrl?: string; /** @description An estimate of the arrival time. */ readonly transitTime?: string; /** @description Specifies the type of shipping option; for example, flat rate, UPS, etc. */ readonly type?: string; }; /** * Pickup Option * @description An option that represents a location where customers can pick up items. */ readonly PickupOption: { readonly pickupMethodId?: number; }; }; responses: { /** @description Cart conflict */ readonly CartConflictErrorResponse: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "status": 409, * "title": "The request cannot be processed due to a possible conflict. Please review the changes and try again.", * "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes" * } */ readonly "application/json": { readonly status?: number; readonly title?: string; readonly type?: string; }; }; }; }; parameters: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly CheckoutIdPath: string; /** @description The ID of the cart associated with this checkout. Identical to the checkout ID. */ readonly CartIdPath: string; /** @description The ID of an item being purchased. */ readonly ItemIdPath: string; /** @description The ID of the subject address. */ readonly AddressIdPath: number; /** @description The ID of the subject consignment. */ readonly ConsignmentIdPath: string; /** @description The code of the subject gift certificate. */ readonly GiftCertificateCodePath: string; /** @description The code of the subject coupon. */ readonly CouponCodePath: string; /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly IncludeShippingDefault: readonly ("cart.lineItems.physicalItems.options" | "cart.lineItems.digitalItems.options" | "cart.lineItems.physicalItems.categoryNames" | "cart.lineItems.digitalItems.categoryNames" | "cart.lineItems.customItems.categoryNames" | "customer" | "customer.customerGroup" | "payments" | "promotions" | "consignments.availableShippingOptions" | "consignments.availablePickupOptions")[]; /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly IncludeShippingPickupDefault: readonly ("cart.lineItems.physicalItems.options" | "cart.lineItems.digitalItems.options" | "cart.lineItems.physicalItems.categoryNames" | "cart.lineItems.digitalItems.categoryNames" | "cart.lineItems.customItems.categoryNames" | "customer" | "customer.customerGroup" | "payments" | "promotions" | "consignments.availableShippingOptions" | "consignments.availablePickupOptions")[]; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly getCheckout: { readonly parameters: { readonly query?: { /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; /** @description When a problem arises, returns a generic response. */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { readonly errors?: readonly { /** Format: int32 */ readonly status?: number; readonly title?: string; readonly type?: string; readonly detail?: string; }[]; }; }; }; }; }; readonly updateCheckout: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["checkout_Put"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly updateCheckoutLineItem: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the cart associated with this checkout. Identical to the checkout ID. */ readonly cartId: components["parameters"]["CartIdPath"]; /** @description The ID of an item being purchased. */ readonly itemId: components["parameters"]["ItemIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["cart_Put"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; readonly deleteCheckoutLineItem: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the cart associated with this checkout. Identical to the checkout ID. */ readonly cartId: components["parameters"]["CartIdPath"]; /** @description The ID of an item being purchased. */ readonly itemId: components["parameters"]["ItemIdPath"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description NOTE: Discounted line items are re-evaluated on cart actions and may be automatically added back to your cart with a new line item ID to satisfy promotional requirements. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; readonly addCheckoutBillingAddress: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["BillingAddressRequest"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; /** @description The email trying to be set for the guest is associated with an account. The customer must sign in. */ readonly 403: { headers: { readonly [name: string]: unknown; }; content?: never; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; /** @description Unable to determine if provided email is associated with an account. The customer must sign in. */ readonly 429: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly updateCheckoutBillingAddress: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the subject address. */ readonly addressId: components["parameters"]["AddressIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["BillingAddressRequest"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; /** @description The email trying to be set for the guest is associated with an account. The customer must sign in. */ readonly 403: { headers: { readonly [name: string]: unknown; }; content?: never; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; /** @description Unable to determine if provided email is associated with an account. The customer must sign in. */ readonly 429: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly createCheckoutConsignment: { readonly parameters: { readonly query?: { /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly include?: components["parameters"]["IncludeShippingDefault"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": readonly components["schemas"]["CreateConsignmentRequest"][]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly updateCheckoutConsignment: { readonly parameters: { readonly query?: { /** @description * `cart.lineItems.physicalItems.options` - physical options * * `cart.lineItems.digitalItems.options` - digital options * * `cart.lineItems.physicalItems.categoryNames` - physical categories * * `cart.lineItems.digitalItems.categoryNames` - digital categories * * `cart.lineItems.customItems.categoryNames` - custom categories * * `customer` - customer * * `customer.customerGroup` - customer group * * `payments` - payments * * `promotions` - promotions * * `consignments.availableShippingOptions` - shipping options * * `consignments.availablePickupOptions` - pickup options */ readonly include?: components["parameters"]["IncludeShippingPickupDefault"]; }; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the subject consignment. */ readonly consignmentId: components["parameters"]["ConsignmentIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["NewUpdateConsignment"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly deleteCheckoutConsignment: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The ID of the subject consignment. */ readonly consignmentId: components["parameters"]["ConsignmentIdPath"]; }; readonly cookie?: never; }; readonly requestBody?: { readonly content: { readonly "application/json": components["schemas"]["DeleteConsignmentRequest"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly addCheckoutGiftCertificate: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["GiftCertificateRequest"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; /** @description Gift certificate code not found */ readonly 404: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": Record; }; }; }; }; readonly deleteCheckoutGiftCertificate: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The code of the subject gift certificate. */ readonly giftCertificateCode: components["parameters"]["GiftCertificateCodePath"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; readonly addCheckoutCoupon: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": { readonly couponCode?: string; /** * @description The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply. * @example 1 */ readonly version?: number; }; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly deleteCheckoutCoupon: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; /** @description The code of the subject coupon. */ readonly couponCode: components["parameters"]["CouponCodePath"]; }; readonly cookie?: never; }; readonly requestBody?: { readonly content: { readonly "application/json": components["schemas"]["DeleteCouponCodeRequest"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { /** @example { * "value": { * "billingAddress": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "id": "5ba11e4a10fb5", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "cart": { * "baseAmount": 119.93, * "cartAmount": 112.93, * "createdTime": "2018-09-18T15:48:26+00:00", * "coupons": [ * { * "id": 1, * "code": "S2549JM0Y", * "displayName": "$5.00 off the order total", * "couponType": "per_total_discount", * "discountedAmount": 5 * } * ], * "currency": { * "name": "US Dollars", * "code": "USD", * "symbol": "$", * "decimalPlaces": 2 * }, * "customerId": 11, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.59 * }, * { * "id": 2, * "discountedAmount": 1.06 * }, * { * "id": 3, * "discountedAmount": 2.12 * }, * { * "id": 4, * "discountedAmount": 0.8 * }, * { * "id": 5, * "discountedAmount": 0.43 * } * ], * "email": "janedoe@example.com", * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isTaxIncluded": false, * "lineItems": { * "physicalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 2, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.59 * }, * { * "id": 2, * "discountedAmount": 2 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 15.99, * "extendedSalePrice": 13.99, * "giftWrapping": {}, * "id": "69791a88-85c9-4c19-8042-e537621e8a55", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 15.99, * "name": "Canvas Laundry Cart", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 17.99, * "productId": 184, * "parentId": "", * "quantity": 1, * "variantId": 364, * "salePrice": 13.99, * "sku": "SMA-RED", * "url": "https://{store_domain}/all/canvas-laundry-cart/" * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "extendedComparisonPrice": 0, * "extendedListPrice": 25, * "extendedSalePrice": 25, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 1.06 * } * ], * "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 25, * "name": "Ceramic Measuring Spoons", * "originalPrice": 25, * "parentId": "", * "productId": 170, * "quantity": 1, * "salePrice": 25, * "sku": "", * "url": "https://{store_domain}/all/ceramic-measuring-spoons/", * "variantId": 341, * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "giftWrapping": {} * }, * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 2.12 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 49.99, * "extendedSalePrice": 49.99, * "giftWrapping": {}, * "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2", * "isShippingRequired": true, * "isTaxable": true, * "listPrice": 49.99, * "name": "Chambray Towel", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 49.99, * "parentId": "", * "productId": 158, * "salePrice": 49.99, * "sku": "SKU-A0C8A203", * "quantity": 1, * "url": "https://{store_domain}/all/chambray-towel/", * "variantId": 376 * } * ], * "digitalItems": [ * { * "addedByPromotion": false, * "brand": "OFS", * "categoryNames": [ * "Essentials", * "Just arrived" * ], * "comparisonPrice": 0, * "couponAmount": 0, * "discountAmount": 0, * "discounts": [ * { * "id": 1, * "discountedAmount": 0.8 * } * ], * "extendedComparisonPrice": 0, * "extendedListPrice": 18.95, * "extendedSalePrice": 18.95, * "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234", * "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2", * "isShippingRequired": false, * "isTaxable": true, * "listPrice": 18.95, * "name": "Gather Journal Issue 7 - Digital", * "options": [ * { * "name": "Color", * "nameId": 1, * "value": "Red", * "valueId": "2" * } * ], * "originalPrice": 18.95, * "parentId": "", * "productId": 189, * "quantity": 1, * "salePrice": 18.95, * "type": "digital", * "variantId": 360, * "url": "https://{store_domain}/all/gather-journal-issue-7/" * } * ], * "giftCertificates": [ * { * "amount": 10, * "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac", * "message": "Thank you!", * "name": "$10.00 Gift Certificate", * "recipient": { * "name": "John Doe", * "email": "johndoe@example.com" * }, * "sender": { * "name": "Jane Doe", * "email": "janedoe@example.com" * }, * "taxable": false, * "theme": "Celebration", * "type": "giftCertificate" * } * ], * "customItems": [] * }, * "locale": "en", * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * }, * "channelId": 1, * "createdTime": "2018-09-18T15:48:26+00:00", * "consignments": [ * { * "address": { * "address1": "123 Main Street", * "address2": "", * "city": "Austin", * "company": "", * "country": "United States", * "countryCode": "US", * "customFields": [ * { * "fieldId": "field_25", * "fieldValue": "Leave in backyard" * } * ], * "email": "janedoe@example.com", * "firstName": "Jane", * "lastName": "Doe", * "phone": "1234567890", * "postalCode": "78751", * "stateOrProvince": "Texas", * "stateOrProvinceCode": "TX" * }, * "availableShippingOptions": [ * { * "additionalDescription": "Fragile items", * "cost": 8, * "description": "Ship by Weight", * "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841", * "imageUrl": "", * "transitTime": "", * "type": "shipping_byweight" * } * ], * "couponDiscounts": [], * "discounts": [], * "handlingCost": 0, * "id": "5ba121929619b", * "lineItemIds": [ * "69791a88-85c9-4c19-8042-e537621e8a55", * "ba2c619d-e6b4-48c2-8809-d88e424ed450", * "c72d6651-978d-45e5-881b-c2bb5f7ff1d5" * ], * "selectedShippingOption": { * "additionalDescription": "Fragile items", * "id": "bb3c818f-17ce-46fe-9475-65933095da0d", * "type": "shipping_upsready", * "description": "UPS® (UPS Next Day Air®)", * "imageUrl": "", * "cost": 69.94, * "transitTime": "1 business day" * }, * "shippingCost": 69.94 * } * ], * "coupons": [ * { * "code": "S2549JM0Y", * "couponType": 2, * "discountedAmount": 5, * "displayName": "$5.00 off the order total", * "id": 1 * } * ], * "fees": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "custom_fee", * "name": "AAINS", * "displayName": "Package Protection Insurance", * "cost": 12.02, * "source": "AA", * "taxClassId": 12 * } * ], * "customer": { * "addresses": [ * {} * ], * "customerGroup": { * "id": 1, * "name": "Wholesale customers" * }, * "email": "string", * "firstName": "string", * "fullName": "string", * "id": 1, * "isGuest": false, * "lastName": "string", * "shouldEncourageSignIn": false, * "storeCredit": 1 * }, * "customerMessage": "Thank you, BigCommerce", * "giftCertificates": [ * { * "balance": 4, * "code": "1234ABC", * "purchaseDate": "string", * "remaining": 2, * "used": 5 * } * ], * "giftWrappingCostTotal": 0, * "grandTotal": 211.49, * "handlingCostTotal": 0, * "id": "b6fbd994-61a8-4f25-9167-6ec10489c448", * "isStoreCreditApplied": false, * "orderId": null, * "outstandingBalance": 0, * "payments": [ * {} * ], * "promotions": [], * "shippingCostBeforeDiscount": 69.94, * "shippingCostTotal": 69.94, * "shouldExecuteSpamCheck": false, * "subtotal": 117.93, * "taxTotal": 28.62, * "taxes": [ * { * "name": "Store Tax", * "amount": 28.62 * } * ], * "updatedTime": "2018-09-18T16:59:45+00:00", * "version": 1 * } * } */ readonly "application/json": components["schemas"]["checkout_Full"]; }; }; readonly 409: components["responses"]["CartConflictErrorResponse"]; }; }; readonly addCheckoutStoreCredit: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; readonly removeCheckoutStoreCredit: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; readonly checkoutSpamProtection: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description The ID of the subject checkout. Identical to the cart ID. */ readonly checkoutId: components["parameters"]["CheckoutIdPath"]; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["SpamProtectionRequest"]; }; }; readonly responses: { /** @description Returns Checkout Object. */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["checkout_Full"]; }; }; }; }; }