Based on mission id query promo code information

Requires read_discounts access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/sales/price_rules/:price_rule_id/batch/:batch_id.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 .

[]

Query the discount code information according to the batch id

Path Parameters

batch_id string required
[]
batch id
[]
Example: 6018676942227642851
price_rule_id string required
[]
Price rule ID
[]
Example: 6018642574989862445

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

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

discount_code_creationobject
[]
Promotion code create mission information
codes_count integer
[]
Mission ready to create promotion code quantities
[]
Example: 1
completed_at string
[]
Created finish time for mission promotion code
[]
Example: 2023-07-11T17:53:39+08:00
created_at string
[]
Created time for missions
[]
Example: 2023-07-11T17:53:30+08:00
failed_count integer
[]
Mission has created a promotion code number of failing
id string
[]
Id for tasks
[]
Example: 6018676942227642851
imported_count integer
[]
Mission has created promotion code quantities
[]
Example: 1
logs array
[]
Created log
[]
Example: []
price_rule_id string
[]
Discount rule ID
[]
Example: 6018642574989862445
started_at string
[]
Mission promotion code created start time
[]
Example: 2023-07-11T17:53:39+08:00
status string
[]
Mission status , queued : confirmed , but not yet started ; running : in progress ; completed : completed
[]
Example: completed
updated_at string
[]
Update time for tasks
[]
Example: 2023-07-11T17:53:39+08:00

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

batch_id — path required

price_rule_id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/price_rules/price_rule_id/batch/batch_id.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