CouponSetList resource

Methods

  • get - Get coupon sets list

Resource

{
    "links": {
        "next": "uri",
        "prev": "uri"
    },
    "results": [
        {
            "assigned": "integer",
            "available": "integer",
            "code": "string",
            "createdAt": "date-time",
            "id": "string",
            "name": "string",
            "quantity": "integer",
            "type": "string",
            "updatedAt": "date-time",
            "usedInWorkflows": [
                {
                    "workflowId": "string"
                }
            ]
        }
    ]
}

Properties

Name Type Description Additional
links object

The pagination links

 Optional
links.next uri

The next list page url if there are more elements

 Optional
links.prev uri

The previous list page url if there is a previous page
results[] array

The coupon set list
results[].assigned integer

The total number of coupon that has been assigned to contacts. Important Remark: this value is updated in batches and changes could be reflected with a maximum delay of 10 seconds
results[].available integer

The total number of available coupons in the coupon set. If the value is null means that is a coupon set of type single unlimited. Important Remark: this value is updated in batches and changes could be reflected with a maximum delay of 10 seconds

 Optional
results[].code string

The code of the coupon set. This field only exists for single coupon sets

 Optional
results[].createdAt date-time

The date of coupon set creation in ISO8601 format
results[].id string

The identifier of the coupon set
results[].name string

The name of the coupon set
results[].quantity integer

The total quantity of coupons in the coupon set. If the value is null means that is a coupon set of type single unlimited

 Optional
results[].type string

The coupon set type

Possible values are:

  • single
  • multiple
results[].updatedAt date-time

The date of coupon set last update in ISO8601 format

 Optional
results[].usedInWorkflows[] array

The list of workflows that are using the coupon set. The usage does not imply that the workflow is in active state. It could be finalized or in draft and having one or more nodes referencing the coupon set
results[].usedInWorkflows[].workflowId string

The identifier of the workflow