post admin api 2020 04 price rules price rule id batch json - admin-api API | Specway Docs

POST

Creates a discount code creation job. The batch endpoint can be used to asynchronously create up to 100 discount codes in a single request. It enqueues and returns a discount_code_creation object that can be monitored for completion. Response fields that are specific to the batch endpoint include: status: The state of the discount code creation job. Possible values are: queued: The job is acknowledged, but not started. running: The job is in process. completed: The job has finished. codes_count: The number of discount codes to create. imported_count: The number of discount codes created successfully. failed_count: The number of discount codes that were not created successfully. Unsuccessful attempts will retry up to three times. logs: A report that specifies when no discount codes were created because the provided data was invalid. Example responses: "Price rule target selection can't be blank" "Price rule allocation method can't be blank"

https://shopify.com/admin/api/2020-04/price_rules/{price_rule_id}/batch.json

https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-04

Access Token Required: API Key

Path Parameters

price_rule_idstringrequired

price_rule_id

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://shopify.com/admin/api/2020-04/price_rules/{price_rule_id}/batch.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}