FOfourthwall
Gifting

Create a gifting checkout

Changed on

Creates a paid checkout for gifting a product to live chat

post/open-api/v1.0/gifting/checkout

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/gifting/checkout
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: giveaway_write
    • or HTTP basic

Request body

offerIdstring required

The product offer to gift to live chat.

quantityinteger required

How many gifts to purchase.

currency'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'INR' | 'JPY' | 'MYR' | 'SGD' | 'MXN' | 'BRL' | 'CHF'

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

Example request

{
  "offerId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "quantity": 1,
  "currency": "USD"
}

Response

Created

checkoutIdstring required

Id of the created checkout.

checkoutUrlstring required

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

Example response

{
  "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  "checkoutUrl": "https://shop.fourthwall.com/checkout/ch_BV44UYrXQA2T_Xcf1288tw"
}

Changes