Skip to main content

Get Promotion Builder Jobs

GET Promotion Builder Jobs​

https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/jobs

Parameters​

Path parameters​

NameRequiredTypeDescription
promotionIDRequiredstringThe unique identifier of the rule promotion.

Headers​

NameRequiredTypeDescription
AuthorizationRequiredstringThe Bearer token required to get access to the API.

Request Example​

curl -X POST https://useast.api.elasticpath.com/v2/rule-promotions/:promotionID/jobs \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \

Response Example​

200 OK

{
    "data": [
        {
            "type": "promotion_job",
            "id": "9bc1391c-1b65-419e-940e-66ed86c07001",
            "rule_promotion_id": "8c150382-b258-4c88-a2d4-b9ea0be74a07",
            "job_type": "code_generate",
            "name": "promo builder",
            "parameters": {
              "number_of_codes": 100,
              "max_uses_per_code": 1,
              "consume_unit": "per_checkout",
              "code_prefix":"summer-",
              "code_length": 8
            },
            "status": "completed",
            "meta": {
                "timestamps": {
                    "created_at": "2024-12-03T23:31:35.962Z",
                    "updated_at": "2024-12-03T23:32:12.609Z"
                }
            },
            "result": {
                "generated": 100
            }
        }
    ]
}