Get one of your discount codes by ID

GET

/api/v1/scent/discount-codes/{id}

const url = 'https://api-omni.linra.net/api/v1/scent/discount-codes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-omni.linra.net/api/v1/scent/discount-codes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

The code, including usage stats.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

string format: uuid

partnerId

string format: uuid

code

string

discountType

A percentage (0,100] off, or a flat SAR amount off.

string

Allowed values: Percent FixedAmount

value

number format: decimal

validFrom

string format: date-time

nullable

validTo

string format: date-time

nullable

isActive

boolean

totalUsageCap

integer

nullable

perCustomerCap

integer

nullable

productScope

Applies to your whole catalog, or to an explicit variant list (see scopedVariantIds).

string

Allowed values: All VariantList

scopedVariantIds

Array<string>

minOrderValue

number format: decimal

nullable

usageCount

Running total of successful redemptions.

integer

createdAt

string format: date-time

nullable

lastModifiedAt

string format: date-time

nullable

Example

{
  "state": "SUCCESS",
  "payload": {
    "discountType": "Percent",
    "productScope": "All"
  }
}

404

Unknown code (or it belongs to another account).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Examples

notFound

{
  "state": "NOT_FOUND_DISCOUNT_CODE",
  "payload": null,
  "details": {}
}

429

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.