Skip to main content
GET
Quote the Krti saving for an amount

Query Parameters

key
string
required

The store's public key (partners console, Website messaging).

Pattern: ^pk_(live|test)_[0-9A-Za-z]{22}$
Example:

"pk_live_7Qm3kXbN2pLw9ZtRa4Vy8s"

amount
string
required

The product, cart or order amount: plain digits with an optional fraction of at most the currency's decimals (45.000 for KWD). No sign, no exponent, at most 12 integer digits. An amount above the store's maximum answers 200 with offer null.

Pattern: ^[0-9]{1,12}(\.[0-9]{1,6})?$
Example:

"45.000"

currency
string
required

ISO 4217 code; must be the store's currency.

Example:

"KWD"

lang
enum<string>

Language of the shopper-facing strings; else Accept-Language, else en.

Available options:
en,
ar
sku
string

The product's SKU, so SKU-specific offers apply (at most 64 characters).

Maximum string length: 64
source
enum<string>

Where the message is shown. cart enables the nudge.

Available options:
product,
cart

Response

The quote.

merchant
object
required
amount
string
required

The amount asked

currency
string
required
lang
enum<string>
required

The language of reason and methods[].name.

Available options:
en,
ar
offer
object | null
required

The best offer for this amount, or null.

nudge
object | null
required

Only with source=cart and no offer, the closest offer by minimum amount.

methods
object[]
required
popupUrl
string<uri>
required

The Learn more page for this quote.