Create a coupon

How to create a coupon via API

To create a new coupon, send a POST request to the /api/coupons endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/coupons

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.code	string	Required
attributes.customer_single_use	boolean	Optional, default is 'false'
attributes.usage_limit	integer	Optional
attributes.recipient_email	string	Optional
attributes.expires_at	datetime	Optional, default is 'null'
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.promotion_rule	object	Required
relationships.coupon_recipient	object	Optional
relationships.tags	array	Optional

Example

Request

The following request creates a new coupon:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/coupons' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "coupons",
    "attributes": {
      "code": "04371af2-70b3-48d7-8f4e-316b374224c3"
    },
    "relationships": {
      "promotion_rule": {
        "data": {
          "type": "coupon_codes_promotion_rules",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "coupons",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde"
    },
    "attributes": {
      "code": "04371af2-70b3-48d7-8f4e-316b374224c3",
      "customer_single_use": false,
      "usage_limit": 50,
      "usage_count": 20,
      "recipient_email": "[e-mail]",
      "expires_at": "2018-01-01T12:00:00.000Z",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/promotion_rule"
        }
      },
      "coupon_recipient": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/coupon_recipient",
          "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/coupon_recipient"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/events"
        }
      },
      "tags": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/tags",
          "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/tags"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/coupons/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}