Docs
Management API
Checkout Coupons

Checkout Coupons

Add Coupon to Checkout

POST /checkouts/{checkoutId}/coupons

Request

Adds a coupon code to a checkout.

You can use multiple coupons by using this endpoint to apply one coupon at a time on your storefront. Ensure you enable the Promotion Settings in your control panel to allow for multiple coupons per order.

Required Fields

  • coupon_code

Limits

  • Coupon codes have a 50-character limit.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • checkoutId in path - string
    required

    ID of the checkout; the same as 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
  • coupon_code
    string

    Coupon codes have a 50-character limit.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Delete Checkout Coupon

DELETE /checkouts/{checkoutId}/coupons/{couponCode}

Request

Deletes a coupon code from a checkout.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • checkoutId in path - string
    required

    ID of the checkout; the same as the cart ID.

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

    The MIME type of the response body.

  • couponCode in path - string
    required

    The actual coupon code value, not the coupon ID.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?