{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Promotion Jobs API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Promotion Jobs", "type": "folder" }, "items": [ { "info": { "name": "Get Promotion Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/promotions/:promotionID/jobs", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of a promotion." }, { "name": "filter", "value": "", "type": "query", "description": "Specifies the filter attributes." } ] }, "docs": "Retrieves the list of jobs for a specific promotion.\n\nIn the response example, you can see the `result.generated` field, which indicates the number of codes generated during the job processing. Additionally, you may also see the optional `result.deleted` field, indicating the number of codes deleted during the job cancellation. The parameters and result objects are shown only when `job_type` is `code_generate`.\n\n### Filtering\n\nThe following operators and attributes are available when filtering o" }, { "info": { "name": "Create a Promotion Job", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/promotions/:promotionID/jobs", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of a promotion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create an asynchronous job to generate codes and export promotion codes." }, { "info": { "name": "Cancel a Job", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/promotions/:promotionID/jobs/:jobID/cancel", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of a promotion." }, { "name": "jobID", "value": "", "type": "path", "description": "The unique identifier of a job to be canceled." } ] }, "docs": "Cancels an asynchronous job whose status is pending or processing." }, { "info": { "name": "Get Promotion Code Exported File", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/promotions/:promotionID/jobs/:jobID/file", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "promotionID", "value": "", "type": "path", "description": "The unique identifier of a promotion." }, { "name": "jobID", "value": "", "type": "path", "description": "The unique identifier of a job associated with the file." } ] }, "docs": "Retrieves exported codes in a CSV format." } ] } ], "bundled": true }