Cancel a Rule Promotion Job

POST 
https://useast.api.elasticpath.com/v2/rule-promotions/:uuid/jobs/:job-uuid/cancel

Cancels an asynchronous job for a rule promotion if its status is pending or processing.

• Only jobs that have not yet completed can be canceled.
• Once canceled, no further processing occurs, and partially completed results may be deleted.

Request

Path Parameters

uuid stringrequired

The unique identifier of the rule promotion.

job-uuid stringrequired

The unique identifier of the job to be canceled.

Responses

200

Successfully Canceled the Rule Promotion Job

Schema:SchemaExample (auto)

Schema

data object
idstring
A unique ID generated when a job is created.
typestring
Always promotion_job.
Possible values: [promotion_job]
rule_promotion_idstring
A unique ID of a promotion.
job_typestring
The type of job you want to run. For example, code_generate to generate codes or code_export to export codes.
namestring
The name of the job. The maximum length allowed is 50 characters.
parametersobject
statusstring
The status of the job. Please see Overview.
errorstring
The error encountered during job execution, if applicable.
meta object
timestamps object
created_atstring<date-time>
The creation date of the job.
updated_atstring<date-time>
The last updated date of the job.
generate_result object
Represents the result of a promotion job, including the number of generated and deleted promotion codes.
• generated: Total number of successfully generated codes.
• deleted: Number of codes that were deleted during job cancellation, if applicable.
generatedinteger
Number of successfully generated promotion codes.
Example: 1000
deletedinteger | nullnullable
Number of codes deleted due to job cancellation.
Example: 50

{
  "data": {
    "id": "string",
    "type": "promotion_job",
    "rule_promotion_id": "string",
    "job_type": "string",
    "name": "string",
    "parameters": {},
    "status": "string",
    "error": "string",
    "meta": {
      "timestamps": {
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      }
    },
    "generate_result": {
      "generated": 1000,
      "deleted": 50
    }
  }
}

422

Unprocessable Entity

Schema:SchemaExample (auto)

Schema

errors object[]
Array [
statusstring
Example: 422
titlestring
Example: Unprocessable Entity
detailstring
Example: Only pending or processing jobs can be cancelled.
]

{
  "errors": [
    {
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Only pending or processing jobs can be cancelled."
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/rule-promotions/:uuid/jobs/:job-uuid/cancel");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

uuid — pathrequired

job-uuid — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!