Coupons

PreviousSearch NextSearch

sales Rule Coupon Repository V1Get By Id Get

Get coupon by coupon id.

get

/V1/coupons/{couponId}

Path parameters

couponIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/coupons/{couponId}'

200

400

401

500

{
  "rule_id": "<integer>",
  "times_used": "<integer>",
  "is_primary": "<boolean>",
  "coupon_id": "<integer>",
  "code": "<string>",
  "usage_limit": "<integer>",
  "usage_per_customer": "<integer>",
  "expiration_date": "<string>",
  "created_at": "<string>",
  "type": "<integer>",
  "extension_attributes": {
    "ddg_extension_attributes": {
      "email": "<string>",
      "expires_at": "<string>"
    }
  }
}

sales Rule Coupon Repository V1Save Put

Save a coupon.

put

/V1/coupons/{couponId}

Path parameters

couponIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"coupon":{"rule_id":"<integer>","times_used":"<integer>","is_primary":"<boolean>","coupon_id":"<integer>","code":"<string>","usage_limit":"<integer>","usage_per_customer":"<integer>","expiration_date":"<string>","created_at":"<string>","type":"<integer>","extension_attributes":{"ddg_extension_attributes":{"email":"<string>","expires_at":"<string>"}}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/coupons/{couponId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "coupon": {
      "rule_id": "<integer>",
      "times_used": "<integer>",
      "is_primary": "<boolean>",
      "coupon_id": "<integer>",
      "code": "<string>",
      "usage_limit": "<integer>",
      "usage_per_customer": "<integer>",
      "expiration_date": "<string>",
      "created_at": "<string>",
      "type": "<integer>",
      "extension_attributes": {
        "ddg_extension_attributes": {
          "email": "<string>",
          "expires_at": "<string>"
        }
      }
    }
  }'

200

400

401

500

{
  "rule_id": "<integer>",
  "times_used": "<integer>",
  "is_primary": "<boolean>",
  "coupon_id": "<integer>",
  "code": "<string>",
  "usage_limit": "<integer>",
  "usage_per_customer": "<integer>",
  "expiration_date": "<string>",
  "created_at": "<string>",
  "type": "<integer>",
  "extension_attributes": {
    "ddg_extension_attributes": {
      "email": "<string>",
      "expires_at": "<string>"
    }
  }
}

sales Rule Coupon Repository V1Delete By Id Delete

Delete coupon by coupon id.

delete

/V1/coupons/{couponId}

Path parameters

couponIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/coupons/{couponId}'

200

400

401

500

true

sales Rule Coupon Repository V1Save Post

Save a coupon.

post

/V1/coupons

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"coupon":{"rule_id":"<integer>","times_used":"<integer>","is_primary":"<boolean>","coupon_id":"<integer>","code":"<string>","usage_limit":"<integer>","usage_per_customer":"<integer>","expiration_date":"<string>","created_at":"<string>","type":"<integer>","extension_attributes":{"ddg_extension_attributes":{"email":"<string>","expires_at":"<string>"}}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/coupons' \
  --header 'Content-Type: application/json' \
  --data '{
    "coupon": {
      "rule_id": "<integer>",
      "times_used": "<integer>",
      "is_primary": "<boolean>",
      "coupon_id": "<integer>",
      "code": "<string>",
      "usage_limit": "<integer>",
      "usage_per_customer": "<integer>",
      "expiration_date": "<string>",
      "created_at": "<string>",
      "type": "<integer>",
      "extension_attributes": {
        "ddg_extension_attributes": {
          "email": "<string>",
          "expires_at": "<string>"
        }
      }
    }
  }'

200

400

401

500

{
  "rule_id": "<integer>",
  "times_used": "<integer>",
  "is_primary": "<boolean>",
  "coupon_id": "<integer>",
  "code": "<string>",
  "usage_limit": "<integer>",
  "usage_per_customer": "<integer>",
  "expiration_date": "<string>",
  "created_at": "<string>",
  "type": "<integer>",
  "extension_attributes": {
    "ddg_extension_attributes": {
      "email": "<string>",
      "expires_at": "<string>"
    }
  }
}