Skip to main content
POST
Create a gifting checkout
This endpoint is in beta and subject to change.
OAuth scope: giveaway_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowImplicit
Authorization URL
https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
Scopes1
giveaway_write
giveaway_write

Body

application/json
offerId
string
required

The product offer to gift to live chat.

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

quantity
integer<int32>
required

How many gifts to purchase.

Required range: 1 <= x <= 10000
Example:

1

currency
enum<string>

Display currency for the checkout. Defaults to the shop's currency.

Available options:
USD,
EUR,
CAD,
GBP,
AUD,
NZD,
SEK,
NOK,
DKK,
PLN,
INR,
JPY,
MYR,
SGD,
MXN,
BRL,
CHF
Example:

"USD"

Response

201 - application/json

Created

checkoutId
string
required

Id of the created checkout.

Example:

"ch_BV44UYrXQA2T_Xcf1288tw"

checkoutUrl
string
required

Absolute, directable checkout URL on the shop's domain.

Example:

"https://shop.fourthwall.com/checkout/ch_BV44UYrXQA2T_Xcf1288tw"