Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Allowlist

Get Allowlist Item

Retrieve an allowlist entry.

Required API key scope

  • Orders
get/allowlists/{id}

Path parameters

idinteger required

The unique identifier associated with the allowlist entry.

Response

Success

idinteger

The unique identifier associated with the allowlist entry.

type'order' | 'email'

The type of value allowed by this allowlist entry. order is the order number of the allowed order and email is the customer's email address.

valuestring

The allowed value. Returns made using this value will override any other return ineligibility.

created_atstring nullable

The date and time at which the entry was created.

Example response

{
  "id": 1,
  "value": "example@example.com",
  "created_at": "2023-06-09 00:00:00"
}