BigCommerce · Schema

Response Cart Coupons

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
View JSON Schema on GitHub

JSON Schema

bigcommerce-responsecartcoupons-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseCartCoupons",
  "title": "Response Cart Coupons",
  "type": "array",
  "items": {
    "required": [
      "code"
    ],
    "type": "object",
    "properties": {
      "code": {
        "type": "string",
        "description": "The coupon code."
      },
      "couponType": {
        "type": "integer",
        "description": "|Type `int`|Type Name|\n|-|-|\n|`0`|`per_item_discount`|\n|`1`|`percentage_discount`|\n|`2`|`per_total_discount`|\n|`3`|`shipping_discount`|\n|`4`|`free_shipping`|\n|`5`|`promotion`|"
      },
      "discountedAmount": {
        "type": "number",
        "description": "The discounted amount applied within a given context.",
        "format": "float"
      },
      "id": {
        "type": "string",
        "description": "The coupon ID."
      }
    }
  },
  "x-internal": false
}