Coupons

get

Path parameters

shopIdstringrequired

Example: vitae

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/coupons'

200

200

[
  {
    "id": 1,
    "code": "MYCOUPON",
    "salt": "298e8d2e935ca",
    "global": 0,
    "discount": 5,
    "uses": 0,
    "max_uses": null,
    "allowed_emails": null,
    "type": "percentage",
    "expiration_date": null,
    "shop_id": 1,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "products": [
      {
        "id": 1,
        "name": "A Product",
        "stock_count": 0,
        "pivot": {
          "coupon_id": 1,
          "product_id": 1
        }
      }
    ]
  }
]

Coupons retrieved.

post

Path parameters

shopIdstringrequired

Example: vitae

Body

codestringrequired

Example: et

globalbooleanrequired

Example: true

discountnumberrequired

Example: 0.2031

typestring · enumrequired

Example: fixed

Available options:

max_usesnumberoptional

Example: 4341960.005148

expiration_datestringoptional

Must be a valid date.

Example: 2024-09-25T12:35:22

allowed_emailsstring[]optional

Must be a valid email address.

Example: ["[e-mail]"]

productsstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/coupons' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "et",
    "global": true,
    "discount": 0.2031,
    "type": "fixed",
    "max_uses": 4341960.005148,
    "expiration_date": "2024-09-25T12:35:22",
    "allowed_emails": [
      "[e-mail]"
    ],
    "products": null
  }'

200

200

[
  {
    "id": 1,
    "code": "MYCOUPON",
    "salt": "298e8d2e935ca",
    "global": 0,
    "discount": 5,
    "uses": 0,
    "max_uses": null,
    "allowed_emails": null,
    "type": "percentage",
    "expiration_date": null,
    "shop_id": 1,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "products": [
      {
        "id": 1,
        "name": "A Product",
        "stock_count": 0,
        "pivot": {
          "coupon_id": 1,
          "product_id": 1
        }
      }
    ]
  }
]

Coupon created.

get

Path parameters

shopIdstringrequired

Example: adipisci

couponIdstringrequired

Example: architecto

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}'

200

200

{
  "id": 1,
  "code": "MYCOUPON",
  "salt": "298e8d2e935ca",
  "global": 0,
  "discount": 5,
  "uses": 0,
  "max_uses": null,
  "allowed_emails": null,
  "type": "percentage",
  "expiration_date": null,
  "shop_id": 1,
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z",
  "products": [
    {
      "id": 1,
      "name": "A Product",
      "stock_count": 0,
      "pivot": {
        "coupon_id": 1,
        "product_id": 1
      }
    }
  ]
}

Coupon retrieved.

delete

Path parameters

shopIdstringrequired

Example: adipisci

couponIdstringrequired

Example: architecto

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}'

200

200

{
  "message": "Coupon deleted successfully"
}

Coupon deleted.