Create a marketplace offer (card)

Creates one card for the listing and appends it to the end of the display order of its panel (ALL_CARDS by default, or the panel given via panelId). Editable only while the listing is DRAFT / CHANGES_REQUESTED / REJECTED (max 20 cards). A card is purchasable once price is set and inStock is true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9]+$

Application ID (numeric string, stringified bigint)

Body Params
string
required
length ≤ 200

Offer (card) title — English

string
required
length ≤ 200

Offer (card) title — Arabic

string
length ≤ 2000

Offer description (English)

string
length ≤ 2000

Offer description (Arabic)

string
length ≤ 2048

Card thumbnail: absolute https/http URL, a gs:// object path returned by the image upload endpoint, or empty (upload later).

string
enum
required

Card visual design

Allowed:
string
enum
required

Launch behavior: deeplink opens the URL out-of-app; webview loads inside the app WebView; offer is a purchasable offer.

Allowed:
string
required
length ≤ 2048

Launch target. webview requires http(s), deeplink accepts any scheme, offer allows empty string or valid URL.

string
\d{1,7}(\.\d{1,2})?

Unit price as a decimal string (≤ 9,999,999.99). Omit to keep the card not-purchasable.

string
\d{1,7}(\.\d{1,2})?

Pre-discount unit price (shown struck through). Only meaningful when price is set.

string
length ≤ 3
Defaults to SAR

ISO 4217 currency code for the price

boolean
Defaults to true

Whether the card is in stock / purchasable now (default true)

number
1 to 999

Purchase limit per customer. The purchase endpoint rejects once the customer's active orders for this card reach the limit.

string
length ≤ 60

Optional attention badge label (e.g. "New", "Best seller").

string
^#[0-9a-fA-F]{6}$

Hex badge color to style badgeLabel.

string
length ≤ 2048

Full-width hero image for the card's detail screen (distinct from the thumbnail imageUrl).

string
length ≤ 200

Short highlight copy rendered above the card body.

string
length ≤ 2000

Purchase terms (English) shown next to Checkout.

string
length ≤ 2000

Purchase terms (Arabic) shown next to Checkout.

string

ISO 8601 moment after which the card is no longer purchasable (null = never expires).

string
^[0-9]+$

Panel (section) to place the card into (stringified bigint). Defaults to the listing's CARD_GRID panel.

string
enum
Defaults to INSTANT

Fulfillment behavior after payment. INSTANT completes immediately; PARTNER_CONFIRMATION waits for developer action.

Allowed:
Responses

400

Invalid payload, listing not editable in its status, or card limit reached.

401

Missing or invalid developer-portal JWT.

404

Application not found, or no listing to attach offers to.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json