Create promo code created tasks

Requires write_discounts access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/price_rules/:price_rule_id/batch.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Create the task of creating a discount code, and asynchronously execute the creation of a discount code

Path Parameters

price_rule_id string required
[]
Discount rule ID

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

discount_codesobject[] required
[]
Promotion code list , up to 100 limited to
code string required
[]
Promotion code
[]
Example: DISCOUNT_CODE_CONTENT

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

discount_code_creationobject
[]
Promotion code creation information
codes_count integer
[]
Batch ready to create promotion code quantities
[]
Example: 1
completed_at string
[]
Created finish time for mission promo code
[]
Example: 2022-11-21T20:15:40+08:00
created_at string
[]
Created time for the batch
[]
Example: 2022-11-21T20:11:40+08:00
failed_count integer
[]
Batch has created a promo code number of failing
id string
[]
Id for batch
[]
Example: 5682520099208570423
imported_count integer
[]
Mission has created promo code quantities
logs array
[]
Created log
[]
Example: ``
price_rule_id string
[]
Discount rule ID
[]
Example: 5682516987487987235
started_at string
[]
batch promotion code created start time
status string
[]
Batch status , queued : confirmed , but not yet started ; running : in progress ; completed : completed
[]
Example: queued
updated_at string
[]
Update time for the batch
[]
Example: 2022-11-21T20:11:40+08:00

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

price_rule_id — path required

Authorization — header required

Body

Body required

{
  "discount_codes": [
    {
      "code": "DISCOUNT_CODE_CONTENT"
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/price_rules/price_rule_id/batch.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal