Create DiscountCode

Requires write_discounts access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/sales/price_rules/:price_rule_id/discount_codes.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 promo code

Path Parameters

price_rule_id string required

Price rule id

Example: 6018703930879383908

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

discount_codeobject

discount code
code string required

Discount code content
Example: DISCOUNT_CODE_CONTENT
price_rule_id string

Discount code rules id
Example: 6018703930879383908

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

discount_codeobject

Discount code entity
price_rule_id string

Id for discount price rule
Example: 6018703930879383908
update_at string

Update time for discount code
Example: 2023-07-12T00:08:02+08:00
usage_count integer

Number of times used in discount codes
code string

Discount code content
Example: DISCOUNT_CODE_CONTENT
create_at string

Discount code created time
Example: 2023-07-12T00:08:02+08:00
id string

Id for discount code
Example: 6019053959104174638

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

price_rule_id — path required

Authorization — header required

Body

Body required

{
  "discount_code": {
    "price_rule_id": "6018703930879383908\n",
    "code": "DISCOUNT_CODE_CONTENT"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/sales/price_rules/price_rule_id/discount_codes.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