openapi: '3.0.1' info: title: Storefront Checkouts description: |- Manage checkout operations and data using front-end JavaScript on BigCommerce Stencil-powered storefronts. For info about API accounts, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication). version: '' termsOfService: 'https://www.bigcommerce.com/terms' contact: name: BigCommerce url: 'https://www.bigcommerce.com' email: support@bigcommerce.com servers: - url: 'https://{store_domain}/api/storefront' variables: store_domain: default: your_store.example.com description: 'The [URL authority](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL#authority) of the storefront.' tags: - name: Checkout - name: Checkout Billing Address - name: Checkout Cart Items - name: Checkout Consignments - name: Checkout Coupons - name: Checkout Gift Certificates - name: Checkout Spam Protection - name: Checkout Store Credit paths: '/checkouts/{checkoutId}': get: tags: - Checkout summary: 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. operationId: CheckoutsByCheckoutIdGet parameters: - name: checkoutId in: path required: true schema: type: string - name: include in: 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 schema: type: string default: consignments.availableShippingOptions enum: - 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 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkouts_Resp' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' '400': description: When a problem arises, returns a generic response. content: application/json: schema: title: Checkout Error type: object properties: errors: type: array description: '' items: title: Error Inner type: object properties: status: type: integer description: '' format: int32 title: type: string description: '' type: type: string description: '' detail: type: string description: '' put: tags: - Checkout summary: 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. operationId: CheckoutsByCheckoutIdPut parameters: - name: checkoutId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/checkout_Put' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkouts_Resp' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' x-codegen-request-body-name: body '/checkouts/{checkoutId}/carts/{cartId}/items/{itemId}': put: tags: - Checkout Cart Items summary: 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. operationId: CheckoutsCartsItemsItemIdByCheckoutIdAndCartIdPut parameters: - name: checkoutId in: path required: true schema: type: string - name: cartId in: path required: true schema: type: string format: uuid - name: itemId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/cart_Put' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' x-codegen-request-body-name: body delete: tags: - Checkout Cart Items summary: 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. operationId: CheckoutsCartsItemsItemIdByCheckoutIdAndCartIdDelete parameters: - name: checkoutId in: path required: true schema: type: string - name: cartId in: path required: true schema: type: string format: uuid - name: itemId in: path required: true schema: type: string responses: '200': 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.' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: b6fbd994-61a8-4f25-9167-6ec10489c448 cart: id: b6fbd994-61a8-4f25-9167-6ec10489c448 customerId: 11 email: janedoe@example.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: false baseAmount: 119.93 discountAmount: 0 cartAmount: 112.93 coupons: - id: 1 code: S2549JM0Y displayName: $5.00 off the order total couponType: per_total_discount discountedAmount: 5 discounts: - id: 69791a88-85c9-4c19-8042-e537621e8a55 discountedAmount: 2.59 - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 discountedAmount: 1.06 - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 discountedAmount: 2.12 - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 discountedAmount: 0.8 - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac discountedAmount: 0.43 lineItems: physicalItems: - id: 69791a88-85c9-4c19-8042-e537621e8a55 parentId: {} variantId: 364 productId: 184 sku: SMA-RED name: Canvas Laundry Cart url: 'https://{store_domain}/all/canvas-laundry-cart/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 0.59 - id: 2 discountedAmount: 2 discountAmount: 2 couponAmount: 0 originalPrice: 17.99 listPrice: 15.99 salePrice: 13.99 extendedListPrice: 15.99 extendedSalePrice: 13.99 isShippingRequired: true giftWrapping: {} addedByPromotion: false - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 parentId: {} variantId: 341 productId: 170 sku: '' name: Ceramic Measuring Spoons url: 'https://{store_domain}/all/ceramic-measuring-spoons/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 1.06 discountAmount: 0 couponAmount: 0 originalPrice: 25 listPrice: 25 salePrice: 25 extendedListPrice: 25 extendedSalePrice: 25 isShippingRequired: true giftWrapping: {} addedByPromotion: false - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 parentId: {} variantId: 376 productId: 158 sku: SKU-A0C8A203 name: Chambray Towel url: 'https://{store_domain}/all/chambray-towel/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 2.12 discountAmount: 0 couponAmount: 0 originalPrice: 49.99 listPrice: 49.99 salePrice: 49.99 extendedListPrice: 49.99 extendedSalePrice: 49.99 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 parentId: {} variantId: 360 productId: 189 name: Gather Journal Issue 7 - Digital url: 'https://{store_domain}/all/gather-journal-issue-7/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 0.8 discountAmount: 0 couponAmount: 0 originalPrice: 18.95 listPrice: 18.95 salePrice: 18.95 extendedListPrice: 18.95 extendedSalePrice: 18.95 isShippingRequired: false type: digital giftCertificates: - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac name: $10.00 Gift Certificate theme: Celebration amount: 10 taxable: false sender: name: Jane Doe email: janedoe@example.com recipient: name: John Doe email: johndoe@example.com message: Thank you! type: giftCertificate createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T16:59:45+00:00' billingAddress: id: 5ba11e4a10fb5 firstName: Jane lastName: Doe email: janedoe@example.com company: '' address1: 123 Main Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: - fieldId: field_25 fieldValue: Leave in backyard consignments: - id: 5ba121929619b shippingCost: 69.94 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 69791a88-85c9-4c19-8042-e537621e8a55 - ba2c619d-e6b4-48c2-8809-d88e424ed450 - c72d6651-978d-45e5-881b-c2bb5f7ff1d5 selectedShippingOption: id: bb3c818f-17ce-46fe-9475-65933095da0d type: shipping_upsready description: UPS® (UPS Next Day Air®) imageUrl: '' cost: 69.94 transitTime: 1 business day address: firstName: Jane lastName: Doe email: janedoe@example.com company: '' address1: 123 Main Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: - fieldId: field_25 fieldValue: Leave in backyard orderId: null shippingCostTotal: 69.94 shippingCostBeforeDiscount: 69.94 handlingCostTotal: 0 taxTotal: 28.62 coupons: - id: 1 code: S2549JM0Y displayName: $5.00 off the order total couponType: 2 discountedAmount: 5 taxes: - name: Store Tax amount: 28.62 subtotal: 117.93 grandTotal: 211.49 giftCertificates: [] createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T16:59:45+00:00' customerMessage: 'Thank you, BigCommerce' '/checkouts/{checkoutId}/billing-address': post: tags: - Checkout Billing Address summary: 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. operationId: CheckoutsBillingAddressByCheckoutIdPost parameters: - name: checkoutId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/address_Base' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' '403': description: The email trying to be set for the guest is associated with an account. The customer must sign in. content: {} '429': description: Unable to determine if provided email is associated with an account. The customer must sign in. content: {} x-codegen-request-body-name: body '/checkouts/{checkoutId}/billing-address/{addressId}': put: tags: - Checkout Billing Address summary: 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. operationId: CheckoutsBillingAddressByCheckoutIdAndAddressIdPut parameters: - name: checkoutId in: path required: true schema: type: string - name: addressId in: path required: true schema: exclusiveMaximum: false exclusiveMinimum: false type: number format: double requestBody: content: application/json: schema: $ref: '#/components/schemas/address_Base' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: b6fbd994-61a8-4f25-9167-6ec10489c448 cart: id: b6fbd994-61a8-4f25-9167-6ec10489c448 customerId: 11 email: janedoe@example.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: false baseAmount: 119.93 discountAmount: 0 cartAmount: 112.93 coupons: - id: 1 code: S2549JM0Y displayName: $5.00 off the order total couponType: per_total_discount discountedAmount: 5 discounts: - id: 69791a88-85c9-4c19-8042-e537621e8a55 discountedAmount: 2.59 - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 discountedAmount: 1.06 - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 discountedAmount: 2.12 - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 discountedAmount: 0.8 - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac discountedAmount: 0.43 lineItems: physicalItems: - id: 69791a88-85c9-4c19-8042-e537621e8a55 parentId: {} variantId: 364 productId: 184 sku: SMA-RED name: Canvas Laundry Cart url: 'https://{store_domain}/all/canvas-laundry-cart/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 0.59 - id: 2 discountedAmount: 2 discountAmount: 2 couponAmount: 0 originalPrice: 17.99 listPrice: 15.99 salePrice: 13.99 extendedListPrice: 15.99 extendedSalePrice: 13.99 isShippingRequired: true giftWrapping: {} addedByPromotion: false - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 parentId: {} variantId: 341 productId: 170 sku: '' name: Ceramic Measuring Spoons url: 'https://{store_domain}/all/ceramic-measuring-spoons/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 1.06 discountAmount: 0 couponAmount: 0 originalPrice: 25 listPrice: 25 salePrice: 25 extendedListPrice: 25 extendedSalePrice: 25 isShippingRequired: true giftWrapping: {} addedByPromotion: false - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 parentId: {} variantId: 376 productId: 158 sku: SKU-A0C8A203 name: Chambray Towel url: 'https://{store_domain}/all/chambray-towel/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 2.12 discountAmount: 0 couponAmount: 0 originalPrice: 49.99 listPrice: 49.99 salePrice: 49.99 extendedListPrice: 49.99 extendedSalePrice: 49.99 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 parentId: {} variantId: 360 productId: 189 name: Gather Journal Issue 7 - Digital url: 'https://{store_domain}/all/gather-journal-issue-7/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2' discounts: - id: total-coupon discountedAmount: 0.8 discountAmount: 0 couponAmount: 0 originalPrice: 18.95 listPrice: 18.95 salePrice: 18.95 extendedListPrice: 18.95 extendedSalePrice: 18.95 isShippingRequired: false type: digital giftCertificates: - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac name: $10.00 Gift Certificate theme: Celebration amount: 10 taxable: false sender: name: Jane Doe email: janedoe@example.com recipient: name: John Doe email: johndoe@example.com message: Thank you! type: giftCertificate createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T16:59:45+00:00' billingAddress: id: 5ba11e4a10fb5 firstName: Jane lastName: Doe email: janedoe@example.com company: '' address1: 123 Main Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: - fieldId: field_25 fieldValue: Leave in backyard consignments: - id: 5ba121929619b shippingCost: 69.94 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 69791a88-85c9-4c19-8042-e537621e8a55 - ba2c619d-e6b4-48c2-8809-d88e424ed450 - c72d6651-978d-45e5-881b-c2bb5f7ff1d5 selectedShippingOption: id: bb3c818f-17ce-46fe-9475-65933095da0d type: shipping_upsready description: UPS® (UPS Next Day Air®) imageUrl: '' cost: 69.94 transitTime: 1 business day address: firstName: Jane lastName: Doe email: janedoe@example.com company: '' address1: 123 Main Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: - fieldId: field_25 fieldValue: Leave in backyard orderId: null shippingCostTotal: 69.94 shippingCostBeforeDiscount: 69.94 handlingCostTotal: 0 taxTotal: 28.62 coupons: - id: 1 code: S2549JM0Y displayName: $5.00 off the order total couponType: 2 discountedAmount: 5 taxes: - name: Store Tax amount: 28.62 subtotal: 117.93 grandTotal: 211.49 giftCertificates: [] createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T16:59:45+00:00' customerMessage: 'Thank you, BigCommerce' '403': description: The email trying to be set for the guest is associated with an account. The customer must sign in. content: {} '429': description: Unable to determine if provided email is associated with an account. The customer must sign in. content: {} x-codegen-request-body-name: body '/checkouts/{checkoutId}/consignments': post: tags: - Checkout Consignments summary: 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](/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: 1. 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. operationId: CheckoutsConsignmentsByCheckoutIdPost parameters: - name: checkoutId in: path required: true schema: type: string - name: include in: query schema: type: string default: consignments.availableShippingOptions requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CreateConsignmentRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@example.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] shouldSaveAddress: true orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' '/checkouts/{checkoutId}/consignments/{consignmentId}': put: tags: - Checkout Consignments summary: 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. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut parameters: - name: checkoutId in: path required: true schema: type: string - name: consignmentId in: path required: true schema: type: string - name: include in: query schema: type: string default: consignments.availableShippingOptions, consignments.availablePickupOptions requestBody: content: application/json: schema: $ref: '#/components/schemas/NewUpdateConsignment' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] shouldSaveAddress: true orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' x-codegen-request-body-name: body delete: tags: - Checkout Consignments summary: 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. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdDelete parameters: - name: checkoutId in: path required: true schema: type: string - name: consignmentId in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' '/checkouts/{checkoutId}/gift-certificates': post: tags: - Checkout Gift Certificates summary: 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. operationId: CheckoutsGiftCertificatesByCheckoutIdPost parameters: - name: checkoutId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GiftCertificateRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' '404': description: Gift certificate code not found content: application/json: schema: type: object x-codegen-request-body-name: body '/checkouts/{checkoutId}/gift-certificates/{giftCertificateCode}': delete: tags: - Checkout Gift Certificates summary: 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. operationId: CheckoutsGiftCertificatesByCheckoutIdAndGiftCertificateCodeDelete parameters: - name: checkoutId in: path required: true schema: type: string - name: giftCertificateCode in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' '/checkouts/{checkoutId}/coupons': post: tags: - Checkout Coupons summary: 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. operationId: CheckoutsCouponsByCheckoutIdPost parameters: - name: checkoutId in: path required: true schema: type: string requestBody: content: application/json: schema: title: Coupon Code Request type: object properties: couponCode: type: string description: '' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 7.95 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' x-codegen-request-body-name: body '/checkouts/{checkoutId}/coupons/{couponCode}': delete: tags: - Checkout Coupons summary: 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. operationId: CheckoutsCouponsByCheckoutIdAndCouponCodeDelete parameters: - name: checkoutId in: path required: true schema: type: string - name: couponCode in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: b6fbd994-61a8-4f25-9167-6ec10489c448 cart: id: b6fbd994-61a8-4f25-9167-6ec10489c448 customerId: 11 email: janedoe@example.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: false baseAmount: 119.93 discountAmount: 0 cartAmount: 117.93 coupons: [] discounts: - id: 69791a88-85c9-4c19-8042-e537621e8a55 discountedAmount: 2 - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 discountedAmount: 0 - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 discountedAmount: 0 - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 discountedAmount: 0 - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac discountedAmount: 0 lineItems: physicalItems: - id: 69791a88-85c9-4c19-8042-e537621e8a55 variantId: 364 productId: 184 sku: SMA-RED name: Canvas Laundry Cart url: 'https://{store_domain}/all/canvas-laundry-cart/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2' discounts: - id: 2 discountedAmount: 2 discountAmount: 2 couponAmount: 0 originalPrice: 17.99 listPrice: 15.99 salePrice: 13.99 extendedListPrice: 15.99 extendedSalePrice: 13.99 isShippingRequired: true addedByPromotion: false - id: ba2c619d-e6b4-48c2-8809-d88e424ed450 variantId: 341 productId: 170 sku: '' name: Ceramic Measuring Spoons url: 'https://{store_domain}/all/ceramic-measuring-spoons/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 25 listPrice: 25 salePrice: 25 extendedListPrice: 25 extendedSalePrice: 25 isShippingRequired: true addedByPromotion: false - id: c72d6651-978d-45e5-881b-c2bb5f7ff1d5 variantId: 376 productId: 158 sku: SKU-A0C8A203 name: Chambray Towel url: 'https://{store_domain}/all/chambray-towel/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 49.99 listPrice: 49.99 salePrice: 49.99 extendedListPrice: 49.99 extendedSalePrice: 49.99 isShippingRequired: true addedByPromotion: false digitalItems: - id: 6477a4a1-02cf-4287-8bf2-fd043bdd5234 variantId: 360 productId: 189 name: Gather Journal Issue 7 - Digital url: 'https://{store_domain}/all/gather-journal-issue-7/' quantity: 1 isTaxable: true imageUrl: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 originalPrice: 18.95 listPrice: 18.95 salePrice: 18.95 extendedListPrice: 18.95 extendedSalePrice: 18.95 isShippingRequired: false type: digital giftCertificates: - id: 871f1f56-4c88-43c3-a6e5-0a647d83d6ac name: $10.00 Gift Certificate theme: Celebration amount: 10 taxable: false sender: name: Jane Doe email: janedoe@example.com recipient: name: John Doe email: johndoe@example.com message: Thank you! type: giftCertificate createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T17:47:35+00:00' billingAddress: id: 5ba11e4a10fb5 firstName: Jane lastName: Doe email: janedoe@example.com address1: 123 Main Street city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: - fieldId: field_25 fieldValue: Leave in backyard consignments: - id: 5ba13935c977a shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - ba2c619d-e6b4-48c2-8809-d88e424ed450 - c72d6651-978d-45e5-881b-c2bb5f7ff1d5 selectedShippingOption: id: 8458d845-a589-477c-a70d-977eed19e0d6 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Jane lastName: Doe email: '' company: '' address1: 123 Main Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: [] - id: 5ba13995cf156 shippingCost: 62.63 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 69791a88-85c9-4c19-8042-e537621e8a55 selectedShippingOption: id: 989cdc72-2eee-49d8-bc71-5d466f905fdc type: shipping_upsready description: UPS® (UPS Next Day Air®) imageUrl: '' cost: 62.63 transitTime: 1 business day address: firstName: John lastName: Doe email: '' company: '' address1: 555 South Street address2: '' city: Austin stateOrProvince: Texas stateOrProvinceCode: TX country: United States countryCode: US postalCode: '78751' phone: '1234567890' customFields: [] shippingCostTotal: 70.63 shippingCostBeforeDiscount: 70.63 handlingCostTotal: 0 taxTotal: 29.44 coupons: [] taxes: - name: Store Tax amount: 29.44 subtotal: 117.93 grandTotal: 218 giftCertificates: [] createdTime: '2018-09-18T15:48:26+00:00' updatedTime: '2018-09-18T17:47:35+00:00' customerMessage: '' '/checkouts/{checkoutId}/store-credit': post: tags: - Checkout Store Credit summary: 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. operationId: CheckoutStoreCreditAdd parameters: - name: checkoutId in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/checkouts_Resp' delete: tags: - Checkout Store Credit summary: 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. operationId: CheckoutsStoreCreditRemove parameters: - name: checkoutId in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object '/checkouts/{checkoutId}/spam-protection': post: tags: - Checkout Spam Protection summary: 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. operationId: checkoutSpamProtection parameters: - name: checkoutId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SpamProtectionRequest' required: true responses: '200': description: Returns Checkout Object. content: application/json: schema: $ref: '#/components/schemas/checkout_Full' deprecated: false x-codegen-request-body-name: body components: schemas: SpamProtectionRequest: title: SpamProtectionRequest type: object properties: token: type: string x-internal: false checkout_Full: title: checkout_Full type: object properties: id: type: string description: '' format: uuid cart: $ref: '#/components/schemas/checkoutCart' billingAddress: $ref: '#/components/schemas/address_Base' consignments: type: array description: '' items: $ref: '#/components/schemas/consignment_Full' coupons: type: array description: Coupons applied at the checkout level. items: $ref: '#/components/schemas/CheckoutCoupon' orderId: type: string description: '' nullable: true shippingCostTotal: type: number description: Shipping cost before any discounts are applied. format: float giftWrappingCostTotal: type: number description: Gift wrapping cost for all items, including or excluding tax. handlingCostTotal: type: number description: Handling cost for all consignments including or excluding tax. format: float taxTotal: type: number description: '' format: float taxes: type: array items: $ref: '#/components/schemas/checkoutTax' subtotal: type: number description: Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings. format: float grandTotal: type: number description: The total payable amount, before applying any store credit or gift certificate. format: float giftCertificates: type: array description: Applied gift certificate (as a payment method). items: $ref: '#/components/schemas/checkoutGiftCertificates' createdTime: type: string description: Time when the cart was created. updatedTime: type: string description: Time when the cart was last updated. customerMessage: type: string description: Shopperʼs message provided as details for the order to be created from this cart outstandingBalance: type: number description: | `grandTotal` subtract the store-credit amount isStoreCreditApplied: type: boolean description: | `true` value indicates StoreCredit has been applied. description: '' x-internal: false CartCoupon: title: Cart Coupon required: - code type: object properties: id: type: integer description: The coupon ID. code: type: string description: the coupon code displayName: type: string description: The coupon title based on different types provided in control panel section. couponType: type: string description: Key name to identify the type of coupon. enum: - per_item_discount - percentage_discount - per_total_discount - shipping_discount - free_shipping - promotion discountedAmount: type: number description: The discounted amount applied within a given context. format: double x-internal: false CheckoutCoupon: title: Checkout Coupon required: - code type: object properties: id: type: integer description: The coupon ID. code: type: string description: the coupon code displayName: type: string description: The coupon title based on different types provided in control panel section. couponType: type: integer description: |- |Type `int`|Type Name| |-|-| |`0`|`per_item_discount`| |`1`|`percentage_discount`| |`2`|`per_total_discount`| |`3`|`shipping_discount`| |`4`|`free_shipping`| |`5`|`promotion`| discountedAmount: type: number description: The discounted amount applied within a given context. format: double x-internal: false contactEntity: title: contactEntity type: object properties: name: type: string description: '' email: type: string description: '' description: Model for sender and receiver objects. x-internal: false address_Full: title: address_Full description: '' allOf: - $ref: '#/components/schemas/address_Base' - type: object properties: id: type: string description: '' shouldSaveAddress: type: boolean description: Indicates whether we should add this address to the customer address book. x-internal: false address_Base: title: address_Base required: - countryCode type: object properties: firstName: type: string description: '' lastName: type: string description: '' email: type: string description: '' company: type: string description: '' address1: type: string description: '' address2: type: string description: '' city: type: string description: '' stateOrProvince: type: string description: Represents state or province. stateOrProvinceCode: type: string description: '' countryCode: type: string description: 'ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' postalCode: type: string description: '' phone: pattern: '^\+?[1-9]\d{1,14}(x\d{1-5})?$' type: string description: '' customFields: type: array items: $ref: '#/components/schemas/customFields' x-internal: false customFields: title: customFields type: object properties: fieldId: type: string fieldValue: type: 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. 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.' x-internal: false consignment_Full: title: consignment_Full type: object properties: id: type: string description: '' shippingAddress: type: object properties: {} x-deprecated: true address: $ref: '#/components/schemas/address_Full' selectedPickupOption: $ref: '#/components/schemas/PickupOption' availableShippingOptions: type: array description: 'This is available only when "include=consignments.availableShippingOptions" is present in the URL.' items: $ref: '#/components/schemas/consignmentAvailableShippingOptions' selectedShippingOption: title: Selected Shipping Option type: object properties: description: type: string description: Read only. readOnly: true id: type: string description: '' type: type: string description: Specifies the type of shipping option; for example, flat rate, UPS, etc. imageUrl: type: string description: '' cost: type: number description: '' format: double transitTime: type: string description: An estimate of the arrival time. additionalDescription: type: string description: Read only. Field used for Shipping Provider API. readOnly: true couponDiscounts: type: array description: List of consignment discounts applied through coupons. items: title: Consignment Coupon Discount type: object properties: code: type: string description: Coupon code that applied this discount. amount: type: number description: '' format: double discounts: type: array description: List of consignment discounts applied through cart level discounts. items: title: Consignment Discount type: object properties: id: type: string description: Discount rule ID that applied this discount. shippingCost: type: number description: The shipping cost for this consignment. format: double handlingCost: type: number description: The handling cost of shipping for this consignment. format: double lineItemIds: type: array description: '' items: type: string 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. x-internal: false consignmentAvailableShippingOptions: title: consignmentAvailableShippingOptions allOf: - $ref: '#/components/schemas/consignmentShippingOption_Base' - type: object properties: isRecommended: type: boolean description: Is this shipping method the recommended shipping option or not. additionalDescription: type: string x-internal: false checkoutTax: title: checkoutTax type: object properties: name: type: string description: Name of the tax. amount: type: number description: '' format: double x-internal: false checkout_Put: title: checkout_Put type: object properties: customerMessage: type: string description: '' x-internal: false checkouts_Resp: title: checkouts_Resp type: object properties: data: title: Checkout type: object properties: id: type: string description: '' format: uuid cart: title: Cart type: object properties: id: type: string description: Cart ID, provided after creating a cart with a POST. format: uuid customer_id: type: integer description: ID of the customer to which the cart belongs. format: int32 email: type: string description: The cartʼs email. This is the same email that is used in the billing address currency: title: Currency type: object properties: name: type: string description: The currency name. code: type: string description: 'ISO-4217 currency code. (See: http://en.wikipedia.org/wiki/ISO_4217.)' symbol: type: string description: The currency symbol. decimalPlaces: type: number description: The number of decimal places for the currency. For example, the USD currency has two decimal places. format: double description: The currency in which prices are displayed (the store default currency). istaxIncluded: type: boolean description: Boolean representing whether tax information is included. baseAmount: type: number description: The cost of the cart’s contents, before applying discounts. format: double discountAmount: type: number description: Order-based discounted amount only - Excludes coupon discounts and product-based discounts. format: double cartAmount: type: number description: Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes, where applicable. format: double coupons: type: array description: '' items: title: Applied Coupon required: - code type: object properties: id: type: string description: The coupon ID. code: type: string description: the coupon code displayName: type: string description: The coupon title based on different types provided in control panel section. couponType: type: string description: Key name to identify the type of coupon. discountedAmount: type: number description: The discounted amount applied within a given context. format: double discounts: type: array description: '' items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double lineItems: type: object description: '' items: title: Line Item required: - digitalItems - physicalItems type: object properties: physicalItems: type: array description: '' items: title: Item Physical required: - quantity type: object properties: id: type: string description: The line-item ID. parentId: type: string description: The product is part of a bundle, such as a product pick list, then the parentId or the main product ID will populate. variantId: type: integer description: ID of the variant. productId: type: integer description: ID of the product. sku: type: string description: SKU of the variant. name: type: string description: The itemʼs product name. url: type: string description: The product URL. quantity: type: number description: Quantity of this item. format: double isTaxable: type: boolean description: Whether the item is taxable. imageUrl: type: string description: A publicly-accessible URL for an image of this item. discounts: type: array description: A list of discounts applied to this item, as an array of AppliedDiscount objects. items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double discountAmount: type: number description: The total value of all discounts applied to this item (excluding coupon). format: double brand: type: string description: The product's brand. couponAmount: type: number description: The total value of all coupons applied to this item. format: double originalPrice: type: number description: The item’s original price is the same as the product’s default price. listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. format: double salePrice: type: number description: The itemʼs price after all discounts are applied. (The final price before tax calculation.) format: double extendedListPrice: type: number description: The itemʼs list price multiplied by the quantity. format: double extendedSalePrice: type: number description: The itemʼs sale price multiplied by the quantity. format: double type: type: string description: the product type - physical or digital addedByPromotion: type: boolean description: If the item was added automatically by a promotion, such as a coupon or buy one, get one. isShippingRequired: type: boolean description: Whether this item requires shipping to a physical address. isMutable: type: boolean description: '' giftWrapping: title: Gift Wrapping type: object properties: name: type: string description: '' message: type: string description: '' amount: type: number description: '' format: double digitalItems: type: array description: '' items: title: Item Digital required: - quantity type: object properties: id: type: string description: The line-item ID. parentId: type: string description: Bundled items will have their parentʼs item ID. variantId: type: number description: ID of the variant. format: double productId: type: number description: ID of the product. format: double sku: type: string description: SKU of the variant. name: type: string description: The itemʼs product name. url: type: string description: The product URL. quantity: type: number description: Quantity of this item. format: double brand: type: string description: The itemʼs brand. isTaxable: type: boolean description: Whether the item is taxable. imageUrl: type: string description: A publicly-accessible URL for an image of this item. discounts: type: array description: List of discounts applied to this item, as an array of AppliedDiscount objects. items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double discountAmount: type: number description: The total value of all discounts applied to this item (excluding coupon). format: double couponAmount: type: number description: The total value of all coupons applied to this item. format: double originalPrice: type: number description: The item’s original price is the same as the product’s default price. listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. format: double salePrice: type: number description: The itemʼs price after all discounts are applied. (The final price before tax calculation.) format: double extendedListPrice: type: number description: The itemʼs list price multiplied by the quantity. format: double extendedSalePrice: type: number description: The itemʼs sale price multiplied by the quantity. format: double type: type: string description: the product type - physical or digital isMutable: type: boolean description: '' isShippingRequired: type: boolean description: Whether this item requires shipping to a physical address. downloadFileUrls: type: array description: URLs to download all product files. items: type: string downloadPageUrl: type: string description: The URL for the combined downloads page. downloadSize: type: string description: 'Specifies the combined download size in human-readable style; for example, `30MB`.' giftCertificate: type: array description: '' items: title: Item Gift Certificate required: - amount - recipient - sender - theme type: object properties: id: type: string description: Gift certificate identifier name: type: string description: 'The name of the purchased gift certificate; for example, `$20 Gift Certificate`.' theme: type: string description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' amount: type: number description: 'Value must be between $1.00 and $1,000.00.' format: double taxable: type: boolean description: '' sender: title: Contact Entity type: object properties: name: type: string description: '' email: type: string description: '' recipient: title: Contact Entity type: object properties: name: type: string description: '' email: type: string description: '' message: type: string description: Limited to 200 characters. type: type: string description: Explicitly specifying the gift certificate type. customItems: type: array items: title: Item Custom type: object properties: id: type: string description: ID of the custom item sku: type: string description: Custom item SKU name: type: string description: Item name quantity: type: string listPrice: type: string description: Price of the item. With or without tax depending on your store setup. description: |- Add a custom item to the shoppers cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. createdTime: type: string description: Time when the cart was created. updatedTime: type: string description: Time when the cart was last updated. description: A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. billingAddress: title: Address Response type: object allOf: - title: Address Properties required: - countryCode type: object properties: firstName: type: string description: '' lastName: type: string description: '' email: type: string description: '' company: type: string description: '' address1: type: string description: '' address2: type: string description: '' city: type: string description: '' stateOrProvince: type: string description: Represents state or province. stateOrProvinceCode: type: string description: '' countryCode: type: string description: 'ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' postalCode: type: string description: '' phone: pattern: '^\+?[1-9]\d{1,14}(x\d{1-5})?$' type: string description: '' customFields: type: array description: '' items: title: CustomField type: object properties: fieldId: type: string description: '' fieldValue: type: string description: This can also be an array for fields that need to support list of values; for example, a set of checkboxes. - type: object properties: id: type: string description: '' consignments: type: array description: This allows you to have multiple shipping addresses per checkout. Where there is only one shipping address, this array will contain only one value, with all the items. items: title: Consignment type: object properties: id: type: string description: '' shippingAddress: type: object properties: {} x-deprecated: true address: title: Address Response type: object allOf: - title: Address Properties required: - countryCode type: object properties: firstName: type: string description: '' lastName: type: string description: '' email: type: string description: '' company: type: string description: '' address1: type: string description: '' address2: type: string description: '' city: type: string description: '' stateOrProvince: type: string description: Represents state or province. stateOrProvinceCode: type: string description: '' countryCode: type: string description: 'ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' postalCode: type: string description: '' phone: pattern: '^\+?[1-9]\d{1,14}(x\d{1-5})?$' type: string description: '' customFields: type: array description: '' items: title: CustomField type: object properties: fieldId: type: string description: '' fieldValue: type: string description: This can also be an array for fields that need to support list of values; for example, a set of checkboxes. - type: object properties: id: type: string description: '' availableShippingOptions: type: array description: This is available only when "include=consignments.availableShippingOptions" is presented in the URL. items: title: Shipping Option Entity type: object allOf: - title: Selected Shipping Option type: object properties: description: type: string description: Read only. readOnly: true id: type: string description: '' type: type: string description: 'Specified the type of shipping option. Flat rate, UPS, etc.,' imageUrl: type: string description: '' cost: type: number description: '' format: double transitTime: type: string description: An estimate of the arrival time. - type: object properties: isRecommended: type: boolean description: Is this shipping method the recommended shipping option or not. selectedShippingOption: title: Selected Shipping Option type: object properties: description: type: string description: Read only. readOnly: true id: type: string description: '' type: type: string description: Specifies the type of shipping option; for example, flat rate, UPS, etc. imageUrl: type: string description: '' cost: type: number description: '' format: double transitTime: type: string description: An estimate of the arrival time. couponDiscounts: type: array description: List of consignment discounts applied through coupons items: title: Consignment Coupon Discount type: object properties: code: type: string description: Coupon code that applied this discount amount: type: number description: '' format: double discounts: type: array description: List of consignment discounts applied through cart level discounts. items: title: Consignment Discount type: object properties: id: type: string description: Discount rule ID that applied this discount shippingCost: type: number description: The shipping cost for this consignment. format: double handlingCost: type: number description: The handling cost of shipping for this consignment. format: double lineItemIds: type: array description: '' items: type: string description: '' coupons: type: array description: Coupons applied at checkout level. items: $ref: '#/components/schemas/CheckoutCoupon' orderId: type: string description: '' shippingCostTotal: type: number description: Shipping cost before any discounts are applied. format: float giftWrappingCostTotal: type: number description: Gift wrapping for all items, including or excluding tax. handlingCostTotal: type: number description: Handling cost for all consignments including or excluding tax. format: float taxTotal: type: number description: '' format: float taxes: type: array items: type: object properties: name: type: string description: Name of the tax charged. This is either the system default or the custom name created for the tax. example: Texas Taxes amount: type: number description: Amount of the tax. format: float example: 1.12 subtotal: type: number description: Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings. format: float grandTotal: type: number description: The total payable amount, before applying any store credit or gift certificate. format: float giftCertificates: type: array description: Applied gift certificate (as a payment method). items: title: Gift Certificate type: object properties: balance: type: number description: '' format: double code: type: string description: '' purchaseDate: type: string description: '' format: date remaining: type: number description: '' format: double used: type: number description: '' format: double description: The values presented here are projections of how much we would be using out of an existing gift certificate. createdTime: type: string description: Time when the cart was created. updatedTime: type: string description: Time when the cart was last updated. customerMessage: type: string description: Shopperʼs message provided as details for the order to be created from this cart. outstandingBalance: type: number description: | `grandTotal` subtract the store-credit amount isStoreCreditApplied: type: boolean description: | `true` value indicates StoreCredit has been applied. x-internal: false cartLineItemPut: title: cartLineItemPut type: object properties: quantity: type: number description: '' format: double productId: type: number description: '' format: double variantId: type: number description: '' format: double giftWrapping: $ref: '#/components/schemas/cartLineItemGiftWrapping_Put' x-internal: false cartLineItemGiftCertificate_Put: title: cartLineItemGiftCertificate_Put required: - amount - quantity - recipient - sender - theme type: object properties: theme: type: string description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' amount: maximum: 1000 minimum: 1 type: number description: '' format: double sender: $ref: '#/components/schemas/contactEntity' recipient: $ref: '#/components/schemas/contactEntity' message: type: string description: Message shown to recipient, as provided by sender. quantity: type: number description: '' format: double x-internal: false cartLineItemGiftWrapping_Put: title: Gift Wrapping Request Data required: - wrapTogether - wrapDetails type: object nullable: true description: if passing null, it will remove the current gift wrapping for the item properties: wrapTogether: type: boolean description: Boolean value that specifies whether items whether items should be wrapped together or wrapped individually. example: true wrapDetails: type: array 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 items: type: object required: - id properties: id: type: integer description: Identifier of the gift wrapping option selected. example: 0 message: type: string description: Custom gift message. example: Happy Birthday CreateConsignmentRequest: title: Create Consignment Request type: object properties: shippingAddress: type: object properties: {} x-deprecated: true address: title: Address Properties required: - countryCode type: object properties: firstName: type: string description: '' lastName: type: string description: '' email: type: string description: '' company: type: string description: '' address1: type: string description: '' address2: type: string description: '' city: type: string description: '' stateOrProvince: type: string description: Represents state or province. stateOrProvinceCode: type: string description: '' countryCode: type: string description: 'ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' postalCode: type: string description: '' phone: pattern: '^\+?[1-9]\d{1,14}(x\d{1-5})?$' type: string description: '' customFields: type: array items: type: object properties: fieldId: type: string fieldValue: type: string shouldSaveAddress: type: boolean description: Indicates whether we should add this address to the customer address book. lineItems: type: array description: '' items: title: Consignment Line Item required: - itemId - quantity type: object properties: itemId: type: string description: '' quantity: type: integer description: '' format: int32 shippingOptionId: type: string description: '' pickupOption: type: object properties: pickupMethodId: type: integer x-internal: false GiftCertificateRequest: title: Gift Certificate Request type: object properties: giftCertificateCode: type: string description: '' x-internal: false cart_Put: title: cart_Put type: object properties: lineItem: $ref: '#/components/schemas/cartLineItemPut' giftCertificate: $ref: '#/components/schemas/cartLineItemGiftCertificate_Put' x-internal: false NewUpdateConsignment: title: Update Consignment Request type: object properties: shippingAddress: type: object properties: {} x-deprecated: true address: title: Address Properties required: - countryCode type: object properties: firstName: type: string description: '' lastName: type: string description: '' email: type: string description: '' company: type: string description: '' address1: type: string description: '' address2: type: string description: '' city: type: string description: '' stateOrProvince: type: string description: Represents state or province. stateOrProvinceCode: type: string description: '' countryCode: type: string description: 'ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' postalCode: type: string description: '' phone: pattern: '^\+?[1-9]\d{1,14}(x\d{1-5})?$' type: string description: '' customFields: type: array items: type: object properties: fieldId: type: string fieldValue: type: string shouldSaveAddress: type: boolean description: Indicates whether we should add this address to the customer address book. lineItems: type: array description: '' items: title: Consignment Line Item required: - itemId - quantity type: object properties: itemId: type: string description: '' quantity: type: integer description: '' format: int32 shippingOptionId: type: string description: '' pickupOption: type: object properties: pickupMethodId: type: integer 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. x-internal: false checkoutCart: title: checkoutCart type: object properties: id: type: string description: Cart ID, provided after creating a cart with a POST. format: uuid customer_id: type: integer description: ID of the customer to which the cart belongs. format: int32 email: type: string description: The cartʼs email. This is the same email that is used in the billing address. currency: title: Currency type: object properties: name: type: string description: The currency name. code: type: string description: 'ISO-4217 currency code. (See: http://en.wikipedia.org/wiki/ISO_4217.)' symbol: type: string description: The currency symbol. decimalPlaces: type: number description: The number of decimal places for the currency. For example, the USD currency has two decimal places. format: double description: The currency in which prices are displayed; the store default currency. isTaxIncluded: type: boolean description: Boolean representing whether tax information is included. baseAmount: type: number description: Cost of cart’s contents, before applying discounts. format: double discountAmount: type: number description: Discounted amount. format: double cartAmount: type: number description: Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes, where applicable. format: double coupons: type: array description: '' items: $ref: '#/components/schemas/CartCoupon' discounts: type: array description: '' items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double lineItems: type: object description: '' items: title: Line Item required: - digitalItems - physicalItems type: object properties: physicalItems: type: array description: '' items: title: Item Physical required: - quantity type: object properties: id: type: string description: The line-item ID. parentId: type: string description: The product is part of a bundle such as a product pick list, then the parentId or the main product ID will populate. variantId: type: integer description: ID of the variant. productId: type: integer description: ID of the product. sku: type: string description: SKU of the variant. name: type: string description: The itemʼs product name. url: type: string description: The product URL. quantity: type: number description: Quantity of this item. format: double isTaxable: type: boolean description: Whether the item is taxable. imageUrl: type: string description: A publicly-accessible URL for an image of this item. discounts: type: array description: A list of discounts applied to this item, as an array of AppliedDiscount objects. items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double discountAmount: type: number description: The total value of all discounts applied to this item (excluding coupon). format: double couponAmount: type: number description: The total value of all coupons applied to this item. format: double listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. format: double salePrice: type: number description: The itemʼs price after all discounts are applied. The final price before tax calculation. format: double extendedListPrice: type: number description: The itemʼs list price multiplied by the quantity. format: double extendedSalePrice: type: number description: The itemʼs sale price multiplied by the quantity. format: double comparisonPrice: type: number description: The itemʼs comparison price extendedComparisonPrice: type: number description: The itemʼs comparison price multiplied by the quantity. type: type: string description: the product type - physical or digital addedByPromotion: type: boolean description: If the item was added automatically by a promotion, such as a coupon or buy one, get one. isShippingRequired: type: boolean description: Whether this item requires shipping to a physical address. isMutable: type: boolean description: '' giftWrapping: title: Gift Wrapping type: object properties: name: type: string description: '' message: type: string description: '' amount: type: number description: '' format: double digitalItems: type: array description: '' items: title: Item Digital required: - quantity type: object properties: id: type: string description: The line-item ID. parentId: type: string description: Bundled items will have their parentʼs item ID. variantId: type: number description: ID of the variant. format: double productId: type: number description: ID of the product. format: double sku: type: string description: SKU of the variant. name: type: string description: The itemʼs product name. url: type: string description: The product URL. quantity: type: number description: Quantity of this item. format: double isTaxable: type: boolean description: Whether the item is taxable. imageUrl: type: string description: A publicly-accessible URL for an image of this item. discounts: type: array description: A list of discounts applied to this item, as an array of AppliedDiscount objects. items: title: Applied Discount type: object properties: name: type: string description: The name provided by the merchant. discountedAmount: type: number description: The discounted amount applied within a given context. format: double discountAmount: type: number description: The total value of all discounts applied to this item (excluding coupon). format: double couponAmount: type: number description: The total value of all coupons applied to this item. format: double listPrice: type: number description: The item’s list price, as quoted by the manufacturer or distributor. format: double salePrice: type: number description: The itemʼs price after all discounts are applied. The final price before tax calculation. format: double extendedListPrice: type: number description: The itemʼs list price multiplied by the quantity. format: double extendedSalePrice: type: number description: The itemʼs sale price multiplied by the quantity. format: double type: type: string description: The product type - physical or digital. isShippingRequired: type: boolean description: Whether this item requires shipping to a physical address. downloadFileUrls: type: array description: URLs to download all product files. items: type: string downloadPageUrl: type: string description: The URL for the combined downloads page. downloadSize: type: string description: 'Specifies the combined download size in human-readable style; for example, `30MB`.' giftCertificate: type: array description: '' items: title: Item Gift Certificate required: - amount - recipient - sender - theme type: object properties: id: type: string description: Gift certificate identifier name: type: string description: 'The name of the purchased gift certificate; for example, `$20 Gift Certificate`.' theme: type: string description: 'Currently supports `Birthday`, `Boy`, `Celebration`, `Christmas`, `General`, and `Girl`.' amount: type: number description: 'Value must be between $1.00 and $1,000.00.' format: double taxable: type: boolean description: '' sender: title: Contact Entity type: object properties: name: type: string description: '' email: type: string description: '' recipient: title: Contact Entity type: object properties: name: type: string description: '' email: type: string description: '' message: type: string description: Limited to 200 characters. type: type: string description: Explicitly specifying the gift certificate type. customItems: type: array items: title: Item Custom type: object properties: id: type: string description: ID of the custom item. sku: type: string description: Custom item SKU. name: type: string description: Item name. quantity: type: string listPrice: type: string description: Price of the item. With or without tax depending on your store setup. description: |- Add a custom item to the shoppers cart. * Custom items are not added to the catalog. * The price should be set to match the store settings for taxes. createdTime: type: string description: Time when the cart was created. updatedTime: type: string description: Time when the cart was last updated. description: A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. x-internal: false checkoutGiftCertificates: title: checkoutGiftCertificates type: array description: Applied gift certificate (as a payment method). items: title: Gift Certificate type: object properties: balance: type: number description: '' format: double code: type: string description: '' purchaseDate: type: string description: '' format: date remaining: type: number description: '' format: double used: type: number description: '' format: double description: The values presented here are projections of how much we would be using out of an existent gift certificate x-internal: false consignmentShippingOption_Base: title: consignmentShippingOption_Base type: object properties: description: type: string description: Read only. readOnly: true id: type: string description: '' type: type: string description: Specifies the type of shipping option; for example, flat rate, UPS, etc. imageUrl: type: string description: '' cost: type: number description: '' format: double transitTime: type: string description: An estimate of the arrival time. x-internal: false PickupOption: type: object title: Pickup Option description: An option that represents a location where customers can pick up items. properties: pickupMethodId: type: integer responses: Checkout: description: '' content: application/json: schema: $ref: '#/components/schemas/checkout_Full' example: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed cart: id: 29eb9b44-8f33-4e4a-9429-d0e8e24641ed customerId: 18 email: dwaynecole@testing.com currency: name: US Dollars code: USD symbol: $ decimalPlaces: 2 isTaxIncluded: true baseAmount: 7.95 discountAmount: 0 cartAmount: 7.95 coupons: [] discounts: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 discountedAmount: 0 lineItems: physicalItems: - id: 243c9ca2-22b4-417a-8b09-b3fc05778b52 parentId: {} variantId: 345 productId: 174 sku: '' name: 1L Le Parfait Jar url: 'https://{store_domain}/all/1l-le-parfait-jar/' quantity: 1 brand: OFS isTaxable: true imageUrl: 'https://cdn11.bigcommerce.com/s-{store_hash}/products/174/images/425/leparfaitmedium3_1024x1024_1024x1024__37756__81924.1534344526.330.500.jpg?c=2' discounts: [] discountAmount: 0 couponAmount: 0 listPrice: 7.95 salePrice: 7.95 extendedListPrice: 7.95 extendedSalePrice: 7.95 isShippingRequired: true giftWrapping: {} addedByPromotion: false digitalItems: [] giftCertificates: [] customItems: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' billingAddress: id: 5c377ead301c2 firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] consignments: - id: 5c377ead30ac1 shippingCost: 8 handlingCost: 0 couponDiscounts: [] discounts: [] lineItemIds: - 243c9ca2-22b4-417a-8b09-b3fc05778b52 selectedShippingOption: id: d09e05c0-3788-44df-a1bb-b6d3afdf6841 type: shipping_byweight description: Ship by Weight imageUrl: '' cost: 8 transitTime: '' address: firstName: Dwayne lastName: Cole email: dwaynecole@testing.com company: '' address1: Mauna Kea Access Rd address2: '' city: Hilo stateOrProvince: Hawaii stateOrProvinceCode: HI country: United States countryCode: US postalCode: '96720' phone: '8081234567' customFields: [] orderId: null shippingCostTotal: 8 shippingCostBeforeDiscount: 8 handlingCostTotal: 0 taxTotal: 1.22 coupons: [] taxes: - name: Tax amount: 1.22 subtotal: 7.95 grandTotal: 15.95 giftCertificates: [] createdTime: '2019-01-10T17:18:00+00:00' updatedTime: '2019-01-10T17:19:47+00:00' customerMessage: '' parameters: include: name: include in: query schema: type: string default: consignments.availableShippingOptions