Coupons

sales Rule Coupon Repository V1Get By Id Get

get

Get coupon by coupon id.

Path parameters
couponIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/coupons/{couponId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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

put

Save a coupon.

Path parameters
couponIdstringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
put
PUT /V1/coupons/{couponId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "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>"
      }
    }
  }
}
{
  "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

Delete coupon by coupon id.

Path parameters
couponIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
delete
DELETE /V1/coupons/{couponId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

sales Rule Coupon Repository V1Save Post

post

Save a coupon.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
post
POST /V1/coupons HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "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>"
      }
    }
  }
}
{
  "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>"
    }
  }
}
PreviousSearchNextSearch