Create an external promotion

How to create an external promotion via API

To create a new external promotion, send a POST request to the /api/external_promotions endpoint, passing the resource arguments in the request body.

Request

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

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.currency_code	string	Optional
attributes.exclusive	boolean	Optional
attributes.priority	integer	Optional
attributes.starts_at	datetime	Required
attributes.expires_at	datetime	Required
attributes.total_usage_limit	integer	Optional
attributes._disable	boolean	Optional
attributes._enable	boolean	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
attributes.promotion_url	string	Required
relationships.market	object	Optional
relationships.order_amount_promotion_rule	object	Optional
relationships.sku_list_promotion_rule	object	Optional
relationships.coupon_codes_promotion_rule	object	Optional
relationships.custom_promotion_rule	object	Optional
relationships.sku_list	object	Optional
relationships.tags	array	Optional

Example

Request

The following request creates a new external promotion:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/external_promotions' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "external_promotions",
    "attributes": {
      "name": "Personal promotion",
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "promotion_url": "https://external_promotion.yourbrand.com"
    }
  }
}'

Response

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

{
  "data": {
    "id": "xYZkjABcde",
    "type": "external_promotions",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde"
    },
    "attributes": {
      "name": "Personal promotion",
      "type": "percentage_discount_promotions",
      "currency_code": "EUR",
      "exclusive": true,
      "priority": 2,
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "total_usage_limit": 5,
      "total_usage_count": 2,
      "active": true,
      "status": "pending",
      "disabled_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"
      },
      "promotion_url": "https://external_promotion.yourbrand.com",
      "circuit_state": "closed",
      "circuit_failure_count": 5,
      "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c"
    },
    "relationships": {
      "market": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/market",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/market"
        }
      },
      "promotion_rules": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/promotion_rules",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/promotion_rules"
        }
      },
      "order_amount_promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/order_amount_promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/order_amount_promotion_rule"
        }
      },
      "sku_list_promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/sku_list_promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/sku_list_promotion_rule"
        }
      },
      "coupon_codes_promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/coupon_codes_promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/coupon_codes_promotion_rule"
        }
      },
      "custom_promotion_rule": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/custom_promotion_rule",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/custom_promotion_rule"
        }
      },
      "sku_list": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/sku_list",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/sku_list"
        }
      },
      "coupons": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/coupons",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/coupons"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/attachments"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/events"
        }
      },
      "tags": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/tags",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/tags"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/versions"
        }
      },
      "skus": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/relationships/skus",
          "related": "https://yourdomain.commercelayer.io/api/external_promotions/xYZkjABcde/skus"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}