Coupons

GEThttps://api.sellauth.com/v1/shops/{shopId}/coupons

Path parameters

shopId*string

Example: "vitae"

Response

200

Coupons retrieved.

Body

application/json

idinteger

Example: 1

codestring

Example: "MYCOUPON"

saltstring

Example: "298e8d2e935ca"

globalinteger

Example: 0

discountnumber (float)

Example: 5

usesinteger

Example: 0

max_usesnullable integer

allowed_emailsnullable array of string

typestring

Example: "percentage"

expiration_datenullable string (date-time)

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

productsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/coupons', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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
        }
      }
    ]
  }
]

POSThttps://api.sellauth.com/v1/shops/{shopId}/coupons

Path parameters

shopId*string

Example: "vitae"

Body

application/json

code*string

Example: "et"

global*boolean

Example: true

discount*number

Example: 0.2031

type*enum

Example: "fixed"

percentagefixed

max_usesnumber

Example: 4341960.005148

expiration_datestring

Must be a valid date.

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

allowed_emailsarray of string

Must be a valid email address.

productsarray of string

Response

200

Coupon created.

Body

application/json

idinteger

Example: 1

codestring

Example: "MYCOUPON"

saltstring

Example: "298e8d2e935ca"

globalinteger

Example: 0

discountnumber (float)

Example: 5

usesinteger

Example: 0

max_usesnullable integer

allowed_emailsnullable array of string

typestring

Example: "percentage"

expiration_datenullable string (date-time)

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

productsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/coupons', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "et",
      "global": true,
      "discount": 0.2031,
      "type": "fixed"
    }),
});
const data = await response.json();

Response

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
        }
      }
    ]
  }
]

GEThttps://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}

Path parameters

shopId*string

Example: "adipisci"

couponId*string

Example: "architecto"

Response

200

Coupon retrieved.

Body

application/json

idinteger

Example: 1

codestring

Example: "MYCOUPON"

saltstring

Example: "298e8d2e935ca"

globalinteger

Example: 0

discountnumber (float)

Example: 5

usesinteger

Example: 0

max_usesnullable integer

allowed_emailsnullable array of string

typestring

Example: "percentage"

expiration_datenullable string (date-time)

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

productsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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
      }
    }
  ]
}

DELETEhttps://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}

Path parameters

shopId*string

Example: "adipisci"

couponId*string

Example: "architecto"

Response

200

Coupon deleted.

Body

application/json

messagestring

Example: "Coupon deleted successfully"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/coupons/{couponId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "Coupon deleted successfully"
}