List Products

GET/v1/products

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Products action (under Products).
Fill in the fields below, then reference the result from later steps as {{listProducts.response.data}}.

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is `1`.

orderstring

Sorts the results using one of the filtering options, where the dash `-` preceding a sorting option means sorting in a descending order.

One ofcreated_at-created_atupdated_at-updated_attype-typecode-codecampaign-campaigncategory-category

start_datestring (date-time)

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

end_datestring (date-time)

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

Returns 200 with an object. Read it in later steps with {{listProducts.response.data.<field>}}.

objectstring

The type of the object represented by JSON. This object stores information about products in a dictionary.

Default "list"

data_refstring

Identifies the name of the attribute that contains the array of product objects.

Default "products"

productsarray<object>

Contains array of product objects.

totalinteger

Total number of product objects.

json

{
  "object": "list",
  "data_ref": "products",
  "products": [
    {}
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

Was this page helpful?