The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Multiple access scopes needed — refer to each endpoint for access scope requirements.
Note
We recommend using the GraphQL Admin API to manage discounts. The Discount types
available in the GraphQL Admin API are intended to replace the GraphQL Admin PriceRule object and
REST Admin PriceRule and DiscountCode resources.
You can use the PriceRule DiscountCode resource to create discount codes that enable specific discounts to be redeemed. Merchants can distribute discount codes to their customers using a variety of means, such as an email or URL, and customers can apply these codes at checkout.
Each discount code belongs to a price rule, which holds the logic for the discount. For more information, see the PriceRule resource.
To create multiple discount codes that use the same price rule logic, use the batch endpoint. For example, you might allow merchants to create a batch of discount codes that belong to the same price rule but are each personalized for a different customer.
The case-insensitive discount code that customers use at checkout. (maximum: 255 characters)
Use the same value for code as the title property of the associated price rule.
The date and time (ISO 8601 format) when the discount code was created.
The date and time (ISO 8601 format) when the discount code was updated.
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.
You can enqueue a single creation job per a shop and you can't enqueue more until the job completes.
The price_rule_id path parameter is the ID of the price rule that the discount code will belong to. This is required because
each discount code must belong to a price rule.
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"
Requires access scope.
Creates a discount code.
The price_rule_id path parameter is the ID of the price rule that the discount code will belong to. This is required because
each discount code must belong to a price rule.
Requires access scope.
Requires access scope.
Retrieves the location of a discount code.
The discount code's location is returned in the location header, not in the DiscountCode object itself. Depending on your HTTP client, the location of the discount code might follow the location header automatically.
Retrieves a discount code creation job
The price_rule_id path parameter is the ID of the price rule that the discount code creation job was ran for. This is required because
each discount code creation job is associated to a price rule.
The batch_id path parameter is the ID of the discount code creation job for the associated price rule.
Retrieves a list of discount codes for a discount code creation job.
The price_rule_id path parameter is the ID of the price rule that the discount code creation job was ran for.
This is required because each discount code creation job is associated to a price rule.
The batch_id path parameter is the ID of the discount code creation job for the associated price rule.
Discount codes that have been successfully created include a populated id field. Discount codes that
encountered errors during the creation process include a populated errors field.
Requires access scope.
Retrieve a list of discount codes. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
The price_rule_id path parameter is the ID of the price rule that the discount codes belongs to.
Requires access scope.
Retrieves a single discount code.
The price_rule_id path parameter is the ID of the price rule that the discount code belongs to.
This is required because each discount code must belong to a price rule.
The discount_code_id path parameter is the ID of the discount code to retrieve for the associated price rule.
Requires access scope.
Updates an existing discount code.
The price_rule_id path parameter is the ID of the price rule that the discount code belongs to.
This is required because each discount code must belong to a price rule.
The discount_code_id path parameter is the ID of the discount code to update for the associated price rule.
Requires access scope.
Deletes a discount code.
The price_rule_id path parameter is the ID of the price rule that the discount code belongs to.
This is required because each discount code must belong to a price rule.
The discount_code_id path parameter is the ID of the discount code to delete for the associated price rule.