BigCommerce
Storefront API
Checkouts
Checkout Gift Certificates

Storefront Checkouts

Add Gift Certificate to Checkout

POST /checkouts/{checkoutId}/gift-certificates

Request

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.

Parameters

  • store_domain in path - string
  • checkoutId in path - string
    required

    The ID of the subject checkout. Identical to the cart ID.

  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json

  • giftCertificateCode    string

example

Response

Body

object | application/json

  • id    string

  • cart    object

    A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

  • billingAddress    object

  • consignments    array[object]

  • coupons    array[object]

    Coupons applied at the checkout level.

  • orderId    string or null

  • shippingCostTotal    number

    Shipping cost before any discounts are applied.

  • giftWrappingCostTotal    number

    Gift wrapping cost for all items, including or excluding tax.

  • handlingCostTotal    number

    Handling cost for all consignments including or excluding tax.

  • taxTotal    number

  • taxes    array[object]

  • subtotal    number

    Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

  • grandTotal    number

    The total payable amount, before applying any store credit or gift certificate.

  • giftCertificates    array[array]

    Applied gift certificate (as a payment method).

  • createdTime    string

    Time when the cart was created.

  • updatedTime    string

    Time when the cart was last updated.

  • customerMessage    string

    Shopperʼs message provided as details for the order to be created from this cart

  • outstandingBalance    number

    grandTotal subtract the store-credit amount

  • isStoreCreditApplied    boolean

    true value indicates StoreCredit has been applied.

example

Delete Gift Certificate

DELETE /checkouts/{checkoutId}/gift-certificates/{giftCertificateCode}

Request

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.

Parameters

  • store_domain in path - string
  • checkoutId in path - string
    required

    The ID of the subject checkout. Identical to the cart ID.

  • giftCertificateCode in path - string
    required

    The code of the subject gift certificate.

  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

Body

object | application/json

  • id    string

  • cart    object

    A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

  • billingAddress    object

  • consignments    array[object]

  • coupons    array[object]

    Coupons applied at the checkout level.

  • orderId    string or null

  • shippingCostTotal    number

    Shipping cost before any discounts are applied.

  • giftWrappingCostTotal    number

    Gift wrapping cost for all items, including or excluding tax.

  • handlingCostTotal    number

    Handling cost for all consignments including or excluding tax.

  • taxTotal    number

  • taxes    array[object]

  • subtotal    number

    Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

  • grandTotal    number

    The total payable amount, before applying any store credit or gift certificate.

  • giftCertificates    array[array]

    Applied gift certificate (as a payment method).

  • createdTime    string

    Time when the cart was created.

  • updatedTime    string

    Time when the cart was last updated.

  • customerMessage    string

    Shopperʼs message provided as details for the order to be created from this cart

  • outstandingBalance    number

    grandTotal subtract the store-credit amount

  • isStoreCreditApplied    boolean

    true value indicates StoreCredit has been applied.

example

Did you find what you were looking for?
Delete Checkout CouponAdd Gift Certificate to Checkout