Search

sales Rule Coupon Repository V1Get List Get

Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

get

/V1/coupons/search

Query parameters

searchCriteria[filterGroups][0][filters][0][field]string

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]string

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]string

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]string

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]string

Sorting direction.

Example: <string>

searchCriteria[pageSize]string

Page size.

Example: <integer>

searchCriteria[currentPage]string

Current page.

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/coupons/search'

200

401

500

200

{
  "items": [
    {
      "rule_id": "<integer>",
      "times_used": "<integer>",
      "is_primary": "<boolean>",
      "coupon_id": "<integer>",
      "code": "<string>",
      "usage_limit": "<integer>",
      "usage_per_customer": "<integer>",
      "expiration_date": "<string>",
      "created_at": "<string>",
      "type": "<integer>",
      "extension_attributes": {
        "ddg_extension_attributes": {
          "email": "<string>",
          "expires_at": "<string>"
        }
      }
    },
    {
      "rule_id": "<integer>",
      "times_used": "<integer>",
      "is_primary": "<boolean>",
      "coupon_id": "<integer>",
      "code": "<string>",
      "usage_limit": "<integer>",
      "usage_per_customer": "<integer>",
      "expiration_date": "<string>",
      "created_at": "<string>",
      "type": "<integer>",
      "extension_attributes": {
        "ddg_extension_attributes": {
          "email": "<string>",
          "expires_at": "<string>"
        }
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "laborum in exercitation",
            "value": "dolore adipisicing ullamco eu",
            "condition_type": "Ut et"
          },
          {
            "field": "incididunt culp",
            "value": "ullamco",
            "condition_type": "quis sunt non culpa"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "incididunt aliqua labore",
            "value": "dolore enim ad",
            "condition_type": "sed cillum"
          },
          {
            "field": "culpa non",
            "value": "laboris reprehenderit non",
            "condition_type": "qui tempor proident deserunt"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "non sunt rep",
        "direction": "laborum pariatur sunt est"
      },
      {
        "field": "id ullamco proident aliqua",
        "direction": "id"
      }
    ],
    "page_size": -3622123,
    "current_page": -50436947
  },
  "total_count": -29233443
}

OK