younifyd
Menu

List All Coupons

This API helps you to view all coupons.

GET/coupons

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the List All Coupons action (under Coupons).
  3. Fill in the fields below, then reference the result from later steps as {{listAllCoupons.response.data}}.

Request

Query parameters

contextstring

Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.

One ofvieweditDefault "view"

pageinteger

Current page of the collection. Default is 1.

Default 1

per_pageinteger

Maximum number of items to be returned in result set. Default is 10.

Default 10

searchstring

Limit results to those matching a string.

afterstring (date-time)

Limit response to resources published after a given ISO8601 compliant date.

beforestring (date-time)

Limit response to resources published before a given ISO8601 compliant date.

excludearray<integer>

Ensure result set excludes specific IDs.

includearray<integer>

Limit result set to specific ids.

offsetinteger

Offset the result set by a specific number of items.

orderstring

Order sort attribute ascending or descending.

One ofascdescDefault "desc"

orderbystring

Sort collection by object attribute.

One ofdateidincludetitleslugDefault "date"

codestring

Limit result set to resources with a specific code.

Response

Returns 200 with a array<object>. Read it in later steps with {{listAllCoupons.response.data.<field>}}.

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