SAP Commerce Cloud · Schema

Voucher

B2BB2CCommerceCustomer ExperienceEcommerceOmnichannelRetail

Properties

Name Type Description
code string Voucher code
name string Voucher name
description string Voucher description
value number Voucher value
valueFormatted string Formatted voucher value
voucherCode string Applied voucher code
freeShipping boolean Whether voucher provides free shipping
View JSON Schema on GitHub

JSON Schema

sap-commerce-cloud-voucher-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Voucher",
  "title": "Voucher",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Voucher code"
    },
    "name": {
      "type": "string",
      "description": "Voucher name"
    },
    "description": {
      "type": "string",
      "description": "Voucher description"
    },
    "value": {
      "type": "number",
      "format": "double",
      "description": "Voucher value"
    },
    "valueFormatted": {
      "type": "string",
      "description": "Formatted voucher value"
    },
    "voucherCode": {
      "type": "string",
      "description": "Applied voucher code"
    },
    "freeShipping": {
      "type": "boolean",
      "description": "Whether voucher provides free shipping"
    }
  }
}