Skip to main content
API docs by Redocly

Download OpenAPI specification:Download

Introduction

The Fourthwall API provides access to your shop's resources including products, orders, customers, webhooks, and more.

Authentication

See Authentication for more information.

Donations

Endpoints for handling donations.

Get all donations

Returns all donations with pagination

Authorizations:
donation_readshopApiKey
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.DonationV1)
Array
id
required
string
shopId
required
string
status
required
string
Enum: "OPEN" "COMPLETED" "ABANDONED" "CANCELLED" "FAILED"
email
required
string
username
string
message
string
required
object (com.fourthwall.openapi.model.DonationV1.Amounts)
required
object (Money)
value
required
number >= 0
currency
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
      • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
      • "status": "OPEN",
      • "email": "supporter@fourthwall.com",
      • "username": "Johnny123",
      • "message": "Sample message",
      • "amounts": {
        • "total": {
          • "value": 10,
          • "currency": "USD"
          }
        },
      • "createdAt": "2020-08-13T09:05:36.939Z",
      • "updatedAt": "2020-08-13T09:05:36.939Z"
      }
    ],
  • "total": 0
}

Get donation by id

Returns donation by id

Authorizations:
donation_readshopApiKey
path Parameters
donationId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
id
required
string
shopId
required
string
status
required
string
Enum: "OPEN" "COMPLETED" "ABANDONED" "CANCELLED" "FAILED"
email
required
string
username
string
message
string
required
object (com.fourthwall.openapi.model.DonationV1.Amounts)
required
object (Money)
value
required
number >= 0
currency
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "status": "OPEN",
  • "email": "supporter@fourthwall.com",
  • "username": "Johnny123",
  • "message": "Sample message",
  • "amounts": {
    • "total": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}

Fulfillment

Fulfillment APIs that allow you to manually fulfill orders.

Create a fulfillment for an order

Creates a fulfillment with a shipment tracker for provided order items. When trackers change their state, order.status will change to IN_PRODUCTION, PARTIALLY_IN_PRODUCTION, PARTIALLY_SHIPPED, SHIPPED depending on the shipping tracker info. Order updated webhooks will be triggered.

Authorizations:
fulfillment_writeshopApiKey
Request Body schema: application/json
required
orderId
required
string <uuid>
required
Array of objects (com.fourthwall.app.openapi.FulfillmentItem) non-empty
Array (non-empty)
variantId
required
string <uuid>
quantity
required
integer <int32> >= 1
required
object (com.fourthwall.app.openapi.ShippingLabel)
trackingNumber
required
string non-empty
trackingCompany
required
string non-empty

Responses

Response Schema: application/json
fulfillmentId
required
string
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  • "items": [
    • {
      • "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf",
      • "quantity": 1
      }
    ],
  • "shippingLabel": {
    • "trackingNumber": "string",
    • "trackingCompany": "USPS"
    }
}

Response samples

Content type
application/json
{
  • "fulfillmentId": "string"
}

Gifting

Finish draw

Finish draw and select winners

Authorizations:
shopApiKey
path Parameters
id
required
string
Request Body schema: application/json
required
required
Array of com.fourthwall.app.openapi.DrawFinishedRequest.Participant.Twitch (object)
Array
One of
service
required
string
userId
required
string
userName
required
string

Responses

Response Schema: application/json
id
required
string
type
required
string
Enum: "INITIAL" "REDO"
giveawayId
required
string
giveawayFriendlyId
required
string
shopId
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1)
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.GiftDraftV1.Amounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
email
required
string
username
string
message
string
required
Array of com.fourthwall.openapi.model.GiftDraftV1.Gift.Available (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.Cancelled (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToPromotion (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.Redeemed (object)
Array
One of
id
required
string
status
required
string
object (com.fourthwall.openapi.model.GiftDraftV1.Winner)
email
string
username
string
selectedAt
required
string <date-time>
redeemUri
required
string
createdAt
required
string <date-time>
durationSeconds
required
integer <int64>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "participants": [
    • {
      • "service": "string",
      • "userId": "string",
      • "userName": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "gdr_EdJvIXu3SEiXe_QkPavHSA",
  • "type": "INITIAL",
  • "giveawayId": "giv_EdJvIXu3SEiXe_QkPavHSA",
  • "giveawayFriendlyId": "D3XZFWPP",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "offer": {},
  • "amounts": {
    • "subtotal": {
      • "value": 10,
      • "currency": "USD"
      },
    • "total": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "email": "supporter@fourthwall.com",
  • "username": "Johnny123",
  • "message": "Sample message",
  • "gifts": [
    • {
      • "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
      • "status": "string",
      • "winner": {
        • "email": "supporter@fourthwall.com",
        • "username": "Johnny123",
        • "selectedAt": "2020-08-13T09:05:36.939Z",
        • "redeemUri": "string"
        }
      }
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "durationSeconds": 0
}

Get draw

Get draw details

Authorizations:
shopApiKey
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
type
required
string
Enum: "INITIAL" "REDO"
giveawayId
required
string
giveawayFriendlyId
required
string
shopId
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1)
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.GiftDraftV1.Amounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
email
required
string
username
string
message
string
required
Array of com.fourthwall.openapi.model.GiftDraftV1.Gift.Available (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.Cancelled (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToPromotion (object) or com.fourthwall.openapi.model.GiftDraftV1.Gift.Redeemed (object)
Array
One of
id
required
string
status
required
string
object (com.fourthwall.openapi.model.GiftDraftV1.Winner)
email
string
username
string
selectedAt
required
string <date-time>
redeemUri
required
string
createdAt
required
string <date-time>
durationSeconds
required
integer <int64>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "gdr_EdJvIXu3SEiXe_QkPavHSA",
  • "type": "INITIAL",
  • "giveawayId": "giv_EdJvIXu3SEiXe_QkPavHSA",
  • "giveawayFriendlyId": "D3XZFWPP",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "offer": {},
  • "amounts": {
    • "subtotal": {
      • "value": 10,
      • "currency": "USD"
      },
    • "total": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "email": "supporter@fourthwall.com",
  • "username": "Johnny123",
  • "message": "Sample message",
  • "gifts": [
    • {
      • "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
      • "status": "string",
      • "winner": {
        • "email": "supporter@fourthwall.com",
        • "username": "Johnny123",
        • "selectedAt": "2020-08-13T09:05:36.939Z",
        • "redeemUri": "string"
        }
      }
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "durationSeconds": 0
}

Get all giveaway packages

Returns all packages with giveaway links

Authorizations:
shopApiKey

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.GiveawayPackagesV1.GiveawayPackage)
Array
packageId
required
string
createdAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "packages": [
    • {
      • "packageId": "gpg_EdJvIXu3SEiXe_QkPavHSA",
      • "createdAt": "2020-08-13T09:05:36.939Z"
      }
    ]
}

Get giveaway links

Returns all giveaway links for packageId

Authorizations:
shopApiKey
path Parameters
packageId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
packageId
required
string
required
Array of com.fourthwall.openapi.model.GiveawayLinksV1.GiveawayLinkV1.Available (object) or com.fourthwall.openapi.model.GiveawayLinksV1.GiveawayLinkV1.Cancelled (object) or com.fourthwall.openapi.model.GiveawayLinksV1.GiveawayLinkV1.Redeemed (object)
Array
One of
status
required
string
id
required
string
link
required
string
productId
required
string
createdAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{}

Mailing Lists

Access to your mailing list via API.

Get all mailing list entries

Returns all mailing list entries

Authorizations:
shopApiKeyshop_read
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.MailingListEntryV1)
Array
id
required
string
email
required
string
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "email": "string"
      }
    ],
  • "total": 0
}

Orders

Order API to fetch orders.

Get all orders

Returns all orders with pagination

Authorizations:
order_readshopApiKey
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5
email
string
Example: email=supporter@fourthwall.com
createdAt[gt]
string <date-time>
Example: createdAt[gt]=2020-08-13T09:05:36.939Z
createdAt[lt]
string <date-time>
Example: createdAt[lt]=2020-08-13T09:05:36.939Z
updatedAt[gt]
string <date-time>
Example: updatedAt[gt]=2020-08-13T09:05:36.939Z
updatedAt[lt]
string <date-time>
Example: updatedAt[lt]=2020-08-13T09:05:36.939Z
status
Array of strings unique
Items Enum: "CONFIRMED" "PARTIALLY_IN_PRODUCTION" "IN_PRODUCTION" "PARTIALLY_SHIPPED" "SHIPPED" "PARTIALLY_DELIVERED" "DELIVERED" "CANCELLED" "COMPLETED"
Example: status=CONFIRMED

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.OrderV1)
Array
id
required
string
shopId
required
string
friendlyId
required
string
checkoutId
required
string
promotionId
string
status
required
string
Enum: "CONFIRMED" "PARTIALLY_IN_PRODUCTION" "IN_PRODUCTION" "PARTIALLY_SHIPPED" "SHIPPED" "PARTIALLY_DELIVERED" "DELIVERED" "CANCELLED" "COMPLETED"
email
required
string
emailMarketingOptIn
required
boolean
username
string
message
required
string
required
object (com.fourthwall.openapi.model.OrderV1.OrderAmounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (com.fourthwall.openapi.model.OrderV1.Billing)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
object (com.fourthwall.openapi.model.OrderV1.Shipping)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferOrderV1)
Array
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantWithQuantityV1)
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
quantity
required
integer <int32>
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
com.fourthwall.openapi.model.OrderV1.Source.GiveawayLinks (object) or com.fourthwall.openapi.model.OrderV1.Source.Order (object) or com.fourthwall.openapi.model.OrderV1.Source.SamplesOrder (object) or com.fourthwall.openapi.model.OrderV1.Source.TwitchGiftRedemption (object)
One of
type
required
string
giftId
required
string
object (com.fourthwall.openapi.model.OrderV1.TrackingParams)
fbc
string
fbp
string
utm_source
string
utm_medium
string
utm_campaign
string
utm_content
string
utm_term
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
      • "friendlyId": "D3XZFWPP",
      • "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
      • "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
      • "status": "CONFIRMED",
      • "email": "supporter@fourthwall.com",
      • "emailMarketingOptIn": true,
      • "username": "Johnny123",
      • "message": "Sample message",
      • "amounts": {
        • "subtotal": {
          • "value": 10,
          • "currency": "USD"
          },
        • "shipping": {
          • "value": 10,
          • "currency": "USD"
          },
        • "tax": {
          • "value": 10,
          • "currency": "USD"
          },
        • "donation": {
          • "value": 10,
          • "currency": "USD"
          },
        • "discount": {
          • "value": 10,
          • "currency": "USD"
          },
        • "total": {
          • "value": 10,
          • "currency": "USD"
          }
        },
      • "billing": {
        • "address": {
          • "name": "Joe Doe",
          • "address1": "Main Street 1",
          • "address2": "string",
          • "city": "San Francisco",
          • "state": "CA",
          • "country": "US",
          • "zip": 12345,
          • "phone": 123456789
          }
        },
      • "shipping": {
        • "address": {
          • "name": "Joe Doe",
          • "address1": "Main Street 1",
          • "address2": "string",
          • "city": "San Francisco",
          • "state": "CA",
          • "country": "US",
          • "zip": 12345,
          • "phone": 123456789
          }
        },
      • "offers": [
        • {
          • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          • "name": "My t-shirt",
          • "slug": "my-t-shirt",
          • "description": "My t-shirt description",
          • "primaryImage": {},
          • "variant": {
            • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            • "name": "My t-shirt - Black, L",
            • "sku": "WDEK-DRE200L",
            • "unitPrice": {
              • "value": 10,
              • "currency": "USD"
              },
            • "unitCost": {
              • "value": 10,
              • "currency": "USD"
              },
            • "compareAtPrice": {
              • "value": 10,
              • "currency": "USD"
              },
            • "attributes": {
              • "description": "Black, L",
              • "color": {
                • "name": "Black",
                • "swatch": "#000000"
                },
              • "size": {
                • "name": "L"
                }
              },
            • "quantity": 5,
            • "price": {
              • "value": 10,
              • "currency": "USD"
              },
            • "cost": {
              • "value": 10,
              • "currency": "USD"
              },
            • "weight": {
              • "value": 1,
              • "unit": "kg"
              },
            • "dimensions": {
              • "length": 1,
              • "width": 2,
              • "height": 3,
              • "unit": "cm"
              }
            }
          }
        ],
      • "source": {
        • "type": "string",
        • "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
        },
      • "trackingParams": {
        • "fbc": "string",
        • "fbp": "string",
        • "utm_source": "string",
        • "utm_medium": "string",
        • "utm_campaign": "string",
        • "utm_content": "string",
        • "utm_term": "string"
        },
      • "createdAt": "2020-08-13T09:05:36.939Z",
      • "updatedAt": "2020-08-13T09:05:36.939Z"
      }
    ],
  • "total": 0
}

Get order by id

Returns order by id

Authorizations:
order_readshopApiKey
path Parameters
orderId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
id
required
string
shopId
required
string
friendlyId
required
string
checkoutId
required
string
promotionId
string
status
required
string
Enum: "CONFIRMED" "PARTIALLY_IN_PRODUCTION" "IN_PRODUCTION" "PARTIALLY_SHIPPED" "SHIPPED" "PARTIALLY_DELIVERED" "DELIVERED" "CANCELLED" "COMPLETED"
email
required
string
emailMarketingOptIn
required
boolean
username
string
message
required
string
required
object (com.fourthwall.openapi.model.OrderV1.OrderAmounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (com.fourthwall.openapi.model.OrderV1.Billing)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
object (com.fourthwall.openapi.model.OrderV1.Shipping)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferOrderV1)
Array
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantWithQuantityV1)
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
quantity
required
integer <int32>
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
com.fourthwall.openapi.model.OrderV1.Source.GiveawayLinks (object) or com.fourthwall.openapi.model.OrderV1.Source.Order (object) or com.fourthwall.openapi.model.OrderV1.Source.SamplesOrder (object) or com.fourthwall.openapi.model.OrderV1.Source.TwitchGiftRedemption (object)
One of
type
required
string
giftId
required
string
object (com.fourthwall.openapi.model.OrderV1.TrackingParams)
fbc
string
fbp
string
utm_source
string
utm_medium
string
utm_campaign
string
utm_content
string
utm_term
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "friendlyId": "D3XZFWPP",
  • "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  • "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
  • "status": "CONFIRMED",
  • "email": "supporter@fourthwall.com",
  • "emailMarketingOptIn": true,
  • "username": "Johnny123",
  • "message": "Sample message",
  • "amounts": {
    • "subtotal": {
      • "value": 10,
      • "currency": "USD"
      },
    • "shipping": {
      • "value": 10,
      • "currency": "USD"
      },
    • "tax": {
      • "value": 10,
      • "currency": "USD"
      },
    • "donation": {
      • "value": 10,
      • "currency": "USD"
      },
    • "discount": {
      • "value": 10,
      • "currency": "USD"
      },
    • "total": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "billing": {
    • "address": {
      • "name": "Joe Doe",
      • "address1": "Main Street 1",
      • "address2": "string",
      • "city": "San Francisco",
      • "state": "CA",
      • "country": "US",
      • "zip": 12345,
      • "phone": 123456789
      }
    },
  • "shipping": {
    • "address": {
      • "name": "Joe Doe",
      • "address1": "Main Street 1",
      • "address2": "string",
      • "city": "San Francisco",
      • "state": "CA",
      • "country": "US",
      • "zip": 12345,
      • "phone": 123456789
      }
    },
  • "offers": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "name": "My t-shirt",
      • "slug": "my-t-shirt",
      • "description": "My t-shirt description",
      • "primaryImage": {},
      • "variant": {
        • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        • "name": "My t-shirt - Black, L",
        • "sku": "WDEK-DRE200L",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "unitCost": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "attributes": {
          • "description": "Black, L",
          • "color": {
            • "name": "Black",
            • "swatch": "#000000"
            },
          • "size": {
            • "name": "L"
            }
          },
        • "quantity": 5,
        • "price": {
          • "value": 10,
          • "currency": "USD"
          },
        • "cost": {
          • "value": 10,
          • "currency": "USD"
          },
        • "weight": {
          • "value": 1,
          • "unit": "kg"
          },
        • "dimensions": {
          • "length": 1,
          • "width": 2,
          • "height": 3,
          • "unit": "cm"
          }
        }
      }
    ],
  • "source": {
    • "type": "string",
    • "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
    },
  • "trackingParams": {
    • "fbc": "string",
    • "fbp": "string",
    • "utm_source": "string",
    • "utm_medium": "string",
    • "utm_campaign": "string",
    • "utm_content": "string",
    • "utm_term": "string"
    },
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}

Get order by friendly id

Returns order by friendly id

Authorizations:
order_readshopApiKey
path Parameters
friendlyId
required
string
Example: D3XZFWPP

Responses

Response Schema: application/json
id
required
string
shopId
required
string
friendlyId
required
string
checkoutId
required
string
promotionId
string
status
required
string
Enum: "CONFIRMED" "PARTIALLY_IN_PRODUCTION" "IN_PRODUCTION" "PARTIALLY_SHIPPED" "SHIPPED" "PARTIALLY_DELIVERED" "DELIVERED" "CANCELLED" "COMPLETED"
email
required
string
emailMarketingOptIn
required
boolean
username
string
message
required
string
required
object (com.fourthwall.openapi.model.OrderV1.OrderAmounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (com.fourthwall.openapi.model.OrderV1.Billing)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
object (com.fourthwall.openapi.model.OrderV1.Shipping)
required
object (com.fourthwall.openapi.model.Address)
name
required
string
address1
required
string
address2
string
city
required
string
state
required
string
country
required
string
zip
string
phone
string
required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferOrderV1)
Array
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantWithQuantityV1)
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
quantity
required
integer <int32>
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
com.fourthwall.openapi.model.OrderV1.Source.GiveawayLinks (object) or com.fourthwall.openapi.model.OrderV1.Source.Order (object) or com.fourthwall.openapi.model.OrderV1.Source.SamplesOrder (object) or com.fourthwall.openapi.model.OrderV1.Source.TwitchGiftRedemption (object)
One of
type
required
string
giftId
required
string
object (com.fourthwall.openapi.model.OrderV1.TrackingParams)
fbc
string
fbp
string
utm_source
string
utm_medium
string
utm_campaign
string
utm_content
string
utm_term
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "friendlyId": "D3XZFWPP",
  • "checkoutId": "ch_BV44UYrXQA2T_Xcf1288tw",
  • "promotionId": "prm_EdJvIXu3SEiXe_QkPavHSA",
  • "status": "CONFIRMED",
  • "email": "supporter@fourthwall.com",
  • "emailMarketingOptIn": true,
  • "username": "Johnny123",
  • "message": "Sample message",
  • "amounts": {
    • "subtotal": {
      • "value": 10,
      • "currency": "USD"
      },
    • "shipping": {
      • "value": 10,
      • "currency": "USD"
      },
    • "tax": {
      • "value": 10,
      • "currency": "USD"
      },
    • "donation": {
      • "value": 10,
      • "currency": "USD"
      },
    • "discount": {
      • "value": 10,
      • "currency": "USD"
      },
    • "total": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "billing": {
    • "address": {
      • "name": "Joe Doe",
      • "address1": "Main Street 1",
      • "address2": "string",
      • "city": "San Francisco",
      • "state": "CA",
      • "country": "US",
      • "zip": 12345,
      • "phone": 123456789
      }
    },
  • "shipping": {
    • "address": {
      • "name": "Joe Doe",
      • "address1": "Main Street 1",
      • "address2": "string",
      • "city": "San Francisco",
      • "state": "CA",
      • "country": "US",
      • "zip": 12345,
      • "phone": 123456789
      }
    },
  • "offers": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "name": "My t-shirt",
      • "slug": "my-t-shirt",
      • "description": "My t-shirt description",
      • "primaryImage": {},
      • "variant": {
        • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        • "name": "My t-shirt - Black, L",
        • "sku": "WDEK-DRE200L",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "unitCost": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "attributes": {
          • "description": "Black, L",
          • "color": {
            • "name": "Black",
            • "swatch": "#000000"
            },
          • "size": {
            • "name": "L"
            }
          },
        • "quantity": 5,
        • "price": {
          • "value": 10,
          • "currency": "USD"
          },
        • "cost": {
          • "value": 10,
          • "currency": "USD"
          },
        • "weight": {
          • "value": 1,
          • "unit": "kg"
          },
        • "dimensions": {
          • "length": 1,
          • "width": 2,
          • "height": 3,
          • "unit": "cm"
          }
        }
      }
    ],
  • "source": {
    • "type": "string",
    • "giftId": "gft_EdJvIXu3SEiXe_QkPavHSA"
    },
  • "trackingParams": {
    • "fbc": "string",
    • "fbp": "string",
    • "utm_source": "string",
    • "utm_medium": "string",
    • "utm_campaign": "string",
    • "utm_content": "string",
    • "utm_term": "string"
    },
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}

Platform Tokens

Endpoint to get access tokens. See Authentication for clearer documentation.

exchangeToken

query Parameters
client_id
required
string
client_secret
required
string
redirect_uri
string
grant_type
required
string
code
string
refresh_token
string
access_token
string

Responses

Response Schema: application/json
object
Response Schema: */*
object

Response samples

Content type
application/json
{ }

Products (offers)

Product catalog management, including product listings, pricing, availability, and variant configurations for your shop.

Update product (offer) availability by id

Updates a product (offer) availability

Authorizations:
offer_writeshopApiKey
path Parameters
productId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5
Request Body schema: application/json
required
available
required
boolean

Responses

Response Schema: application/json
id
required
string
name
required
string
slug
required
string
description
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.Available (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.SoldOut (object)
One of
type
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Archived (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Hidden (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Public (object)
One of
type
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantV1)
Array
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Limited (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Unlimited (object)
One of
type
required
string
inStock
required
integer <int32>
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.OfferAbstractV1.OfferAdditionalInformationV1)
sizeAndFit
string
guaranteeAndReturns
string
moreDetails
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferSizeGuideV1)
previewUrl
string
fileUrl
string
description
string
fitGuideDescription
string
fitGuideUrls
required
Array of strings
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "available": true
}

Response samples

Content type
application/json
{
  • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  • "name": "My t-shirt",
  • "slug": "my-t-shirt",
  • "description": "My t-shirt description",
  • "state": {
    • "type": "string"
    },
  • "access": {
    • "type": "string"
    },
  • "thumbnailImage": {},
  • "images": [],
  • "variants": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "name": "My t-shirt - Black, L",
      • "sku": "WDEK-DRE200L",
      • "unitPrice": {
        • "value": 10,
        • "currency": "USD"
        },
      • "compareAtPrice": {
        • "value": 10,
        • "currency": "USD"
        },
      • "unitCost": {
        • "value": 10,
        • "currency": "USD"
        },
      • "attributes": {
        • "description": "Black, L",
        • "color": {
          • "name": "Black",
          • "swatch": "#000000"
          },
        • "size": {
          • "name": "L"
          }
        },
      • "stock": {
        • "type": "string",
        • "inStock": 5
        },
      • "weight": {
        • "value": 1,
        • "unit": "kg"
        },
      • "dimensions": {
        • "length": 1,
        • "width": 2,
        • "height": 3,
        • "unit": "cm"
        },
      • "images": [],
      • "thumbnailImage": {}
      }
    ],
  • "additionalInformation": {
    • "sizeAndFit": "string",
    • "guaranteeAndReturns": "string",
    • "moreDetails": "string"
    },
  • "sizeGuide": {
    • "previewUrl": "string",
    • "fileUrl": "string",
    • "description": "string",
    • "fitGuideDescription": "string",
    • "fitGuideUrls": [
      • "string"
      ]
    },
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}

Get all products (offers)

Returns all products with pagination

Authorizations:
offer_readshopApiKey
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5
search
string
Example: search=search_phrase

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferFullV1)
Array
id
required
string
name
required
string
slug
required
string
description
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.Available (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.SoldOut (object)
One of
type
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Archived (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Hidden (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Public (object)
One of
type
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantV1)
Array
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Limited (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Unlimited (object)
One of
type
required
string
inStock
required
integer <int32>
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.OfferAbstractV1.OfferAdditionalInformationV1)
sizeAndFit
string
guaranteeAndReturns
string
moreDetails
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferSizeGuideV1)
previewUrl
string
fileUrl
string
description
string
fitGuideDescription
string
fitGuideUrls
required
Array of strings
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "name": "My t-shirt",
      • "slug": "my-t-shirt",
      • "description": "My t-shirt description",
      • "state": {
        • "type": "string"
        },
      • "access": {
        • "type": "string"
        },
      • "thumbnailImage": {},
      • "images": [],
      • "variants": [
        • {
          • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          • "name": "My t-shirt - Black, L",
          • "sku": "WDEK-DRE200L",
          • "unitPrice": {
            • "value": 10,
            • "currency": "USD"
            },
          • "compareAtPrice": {
            • "value": 10,
            • "currency": "USD"
            },
          • "unitCost": {
            • "value": 10,
            • "currency": "USD"
            },
          • "attributes": {
            • "description": "Black, L",
            • "color": {
              • "name": "Black",
              • "swatch": "#000000"
              },
            • "size": {
              • "name": "L"
              }
            },
          • "stock": {
            • "type": "string",
            • "inStock": 5
            },
          • "weight": {
            • "value": 1,
            • "unit": "kg"
            },
          • "dimensions": {
            • "length": 1,
            • "width": 2,
            • "height": 3,
            • "unit": "cm"
            },
          • "images": [],
          • "thumbnailImage": {}
          }
        ],
      • "additionalInformation": {
        • "sizeAndFit": "string",
        • "guaranteeAndReturns": "string",
        • "moreDetails": "string"
        },
      • "sizeGuide": {
        • "previewUrl": "string",
        • "fileUrl": "string",
        • "description": "string",
        • "fitGuideDescription": "string",
        • "fitGuideUrls": [
          • "string"
          ]
        },
      • "createdAt": "2020-08-13T09:05:36.939Z",
      • "updatedAt": "2020-08-13T09:05:36.939Z"
      }
    ],
  • "total": 0
}

Get product (offer) by id

Returns product by id

Authorizations:
offer_readshopApiKey
path Parameters
productId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
id
required
string
name
required
string
slug
required
string
description
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.Available (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.SoldOut (object)
One of
type
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Archived (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Hidden (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Public (object)
One of
type
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
Array of objects (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantV1)
Array
id
required
string
name
required
string
sku
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
object (Money)
value
required
number >= 0
currency
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes)
description
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color)
name
required
string
swatch
required
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size)
name
required
string
required
com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Limited (object) or com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Unlimited (object)
One of
type
required
string
inStock
required
integer <int32>
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight)
value
required
number
unit
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions)
length
required
number
width
required
number
height
required
number
unit
required
string
required
Array of objects (com.fourthwall.openapi.model.Image)
Array
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

object (com.fourthwall.openapi.model.OfferAbstractV1.OfferAdditionalInformationV1)
sizeAndFit
string
guaranteeAndReturns
string
moreDetails
string
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferSizeGuideV1)
previewUrl
string
fileUrl
string
description
string
fitGuideDescription
string
fitGuideUrls
required
Array of strings
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  • "name": "My t-shirt",
  • "slug": "my-t-shirt",
  • "description": "My t-shirt description",
  • "state": {
    • "type": "string"
    },
  • "access": {
    • "type": "string"
    },
  • "thumbnailImage": {},
  • "images": [],
  • "variants": [
    • {
      • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      • "name": "My t-shirt - Black, L",
      • "sku": "WDEK-DRE200L",
      • "unitPrice": {
        • "value": 10,
        • "currency": "USD"
        },
      • "compareAtPrice": {
        • "value": 10,
        • "currency": "USD"
        },
      • "unitCost": {
        • "value": 10,
        • "currency": "USD"
        },
      • "attributes": {
        • "description": "Black, L",
        • "color": {
          • "name": "Black",
          • "swatch": "#000000"
          },
        • "size": {
          • "name": "L"
          }
        },
      • "stock": {
        • "type": "string",
        • "inStock": 5
        },
      • "weight": {
        • "value": 1,
        • "unit": "kg"
        },
      • "dimensions": {
        • "length": 1,
        • "width": 2,
        • "height": 3,
        • "unit": "cm"
        },
      • "images": [],
      • "thumbnailImage": {}
      }
    ],
  • "additionalInformation": {
    • "sizeAndFit": "string",
    • "guaranteeAndReturns": "string",
    • "moreDetails": "string"
    },
  • "sizeGuide": {
    • "previewUrl": "string",
    • "fileUrl": "string",
    • "description": "string",
    • "fitGuideDescription": "string",
    • "fitGuideUrls": [
      • "string"
      ]
    },
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}

Get product (offer) inventory by id

Returns product (offer) inventory by id

Authorizations:
offer_readshopApiKey
path Parameters
productId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.StockV1)
Array
variantId
required
string <uuid>
quantity
required
integer <int32>
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf",
      • "quantity": 0,
      • "createdAt": "2019-08-24T14:15:22Z",
      • "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
  • "total": 0
}

Promotions

Manage promotions for your shop.

Get all promotions

Returns all promotions

Authorizations:
promotions_readshopApiKey
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5

Responses

Response Schema: application/json
required
Array of com.fourthwall.openapi.model.promotions.AutoApplyingShopPromotionV1 (object) or com.fourthwall.openapi.model.promotions.MultiMembershipsPromotionV1 (object) or com.fourthwall.openapi.model.promotions.MultiShopPromotionV1 (object) or com.fourthwall.openapi.model.promotions.SingleMembershipsPromotionV1 (object) or com.fourthwall.openapi.model.promotions.SingleShopPromotionV1 (object)
Array
One of
type
required
string
id
required
string
title
required
string
code
required
string
required
com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FixedAmount (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeShipping (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.Percentage (object)
One of
type
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
freeShipping
required
boolean
status
required
string
Enum: "Live" "Ended" "Archived" "AllUsed"
required
object (com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop)
object (Money)
value
required
number >= 0
currency
required
string
usageCount
required
integer <int32>
required
object (com.fourthwall.openapi.model.promotions.PromotionLimitsV1)
maximumUsesNumber
integer <int32>
oneUsePerCustomer
boolean
required
com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrder (object) or com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.SelectedProducts (object)
One of
type
required
string
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "type": "string",
      • "id": "string",
      • "title": "string",
      • "code": "string",
      • "discount": {
        • "type": "string",
        • "money": {
          • "value": 10,
          • "currency": "USD"
          },
        • "freeShipping": true
        },
      • "status": "Live",
      • "requirements": {
        • "minimumOrderValue": {
          • "value": 10,
          • "currency": "USD"
          }
        },
      • "usageCount": 0,
      • "limits": {
        • "maximumUsesNumber": 0,
        • "oneUsePerCustomer": true
        },
      • "appliesTo": {
        • "type": "string"
        }
      }
    ],
  • "total": 0
}

Create a promotion

Creates a promotion

Authorizations:
promotions_writeshopApiKey
Request Body schema: application/json
required
One of
type
required
string
codes
required
Array of strings
required
com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionDiscountType.Memberships.Percentage (object)
One of
type
required
string
percentage
required
number
object (com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionRequirements.Memberships)
newMembersOnly
required
boolean
com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionMembershipSubscriptionTypeAppliesTo.AllMembers (object) or com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionMembershipSubscriptionTypeAppliesTo.AnnualMembersOnly (object) or com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionMembershipSubscriptionTypeAppliesTo.MonthlyMembersOnly (object)
One of
type
required
string
com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionMembershipTiersAppliesTo.AllTiers (object) or com.fourthwall.app.openapi.model.requests.promotions.OpenApiPromotionMembershipTiersAppliesTo.SelectedTiers (object)
One of
type
required
string

Responses

Response Schema: application/json
One of
type
required
string
id
required
string
title
required
string
code
required
string
required
com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FixedAmount (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeShipping (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.Percentage (object)
One of
type
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
freeShipping
required
boolean
status
required
string
Enum: "Live" "Ended" "Archived" "AllUsed"
required
object (com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop)
object (Money)
value
required
number >= 0
currency
required
string
usageCount
required
integer <int32>
required
object (com.fourthwall.openapi.model.promotions.PromotionLimitsV1)
maximumUsesNumber
integer <int32>
oneUsePerCustomer
boolean
required
com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrder (object) or com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.SelectedProducts (object)
One of
type
required
string
Response Schema: */*
object

Request samples

Content type
application/json
Example
{
  • "type": "string",
  • "codes": [
    • "string"
    ],
  • "discount": {
    • "type": "string",
    • "percentage": 0
    },
  • "requirements": {
    • "newMembersOnly": true
    },
  • "subscriptionType": {
    • "type": "string"
    },
  • "tiers": {
    • "type": "string"
    }
}

Response samples

Content type
application/json
Example
{
  • "type": "string",
  • "id": "string",
  • "title": "string",
  • "code": "string",
  • "discount": {
    • "type": "string",
    • "money": {
      • "value": 10,
      • "currency": "USD"
      },
    • "freeShipping": true
    },
  • "status": "Live",
  • "requirements": {
    • "minimumOrderValue": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "usageCount": 0,
  • "limits": {
    • "maximumUsesNumber": 0,
    • "oneUsePerCustomer": true
    },
  • "appliesTo": {
    • "type": "string"
    }
}

Get a promotion by id

Returns a promotion by id

Authorizations:
promotions_readshopApiKey
path Parameters
promotionId
required
string
Example: 00aa4abd-5778-4199-8161-0b49b2f212e5

Responses

Response Schema: application/json
One of
type
required
string
id
required
string
title
required
string
code
required
string
required
com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FixedAmount (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeShipping (object) or com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.Percentage (object)
One of
type
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
freeShipping
required
boolean
status
required
string
Enum: "Live" "Ended" "Archived" "AllUsed"
required
object (com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop)
object (Money)
value
required
number >= 0
currency
required
string
usageCount
required
integer <int32>
required
object (com.fourthwall.openapi.model.promotions.PromotionLimitsV1)
maximumUsesNumber
integer <int32>
oneUsePerCustomer
boolean
required
com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrder (object) or com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.SelectedProducts (object)
One of
type
required
string
Response Schema: */*
object

Response samples

Content type
application/json
Example
{
  • "type": "string",
  • "id": "string",
  • "title": "string",
  • "code": "string",
  • "discount": {
    • "type": "string",
    • "money": {
      • "value": 10,
      • "currency": "USD"
      },
    • "freeShipping": true
    },
  • "status": "Live",
  • "requirements": {
    • "minimumOrderValue": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "usageCount": 0,
  • "limits": {
    • "maximumUsesNumber": 0,
    • "oneUsePerCustomer": true
    },
  • "appliesTo": {
    • "type": "string"
    }
}

Shop

Get information about your shop.

Get current shop

Returns the current shop

Authorizations:
NoneshopApiKey

Responses

Response Schema: application/json
id
required
string
name
required
string
domain
required
string
publicDomain
required
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  • "name": "string",
  • "domain": "string",
  • "publicDomain": "string"
}

Get current shop contact info

Returns the current shop contact info

Authorizations:
shop_readshopApiKey

Responses

Response Schema: application/json
shopEmail
required
string
contactEmail
required
string
transactionalEmail
required
string
customerSupportEmail
string
phone
required
string
shopName
required
string
domain
required
string
required
object (com.fourthwall.openapi.model.AddressV1)
name
required
string
address1
required
string
address2
required
string
city
required
string
state
required
string
zip
required
string
country
required
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "shopEmail": "string",
  • "contactEmail": "string",
  • "transactionalEmail": "string",
  • "customerSupportEmail": "string",
  • "phone": "string",
  • "shopName": "string",
  • "domain": "string",
  • "location": {
    • "name": "string",
    • "address1": "string",
    • "address2": "string",
    • "city": "string",
    • "state": "string",
    • "zip": "string",
    • "country": "string"
    }
}

Streaming

Set streaming status for your shop, which will be displayed on your storefront and enable giveaways (for Twitch).

Set streaming status to started

Sets streaming status to started for specified services

Authorizations:
shopApiKey
Request Body schema: application/json
required
required
Array of com.fourthwall.app.openapi.StreamingStartedRequest.Service.Twitch (object)
Array
One of
type
required
string
broadcasterId
required
string
broadcasterLogin
required
string
thumbnailUrl
string

Responses

Response Schema: application/json
shopId
required
string
required
Array of com.fourthwall.openapi.model.StreamingStatusV1.Service.Twitch (object)
Array
One of
type
required
string
status
required
string
Enum: "ONLINE" "OFFLINE"
broadcasterId
string
broadcasterLogin
string
thumbnailUrl
string
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "services": [
    • {
      • "type": "string",
      • "broadcasterId": "string",
      • "broadcasterLogin": "string",
      • "thumbnailUrl": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "shopId": "string",
  • "services": [
    • {
      • "type": "string",
      • "status": "ONLINE",
      • "broadcasterId": "string",
      • "broadcasterLogin": "string",
      • "thumbnailUrl": "string"
      }
    ]
}

Set streaming status to ended

Sets streaming status to ended for specified services

Authorizations:
shopApiKey
Request Body schema: application/json
required
services
required
Array of strings
Items Value: "TWITCH"

Responses

Response Schema: application/json
shopId
required
string
required
Array of com.fourthwall.openapi.model.StreamingStatusV1.Service.Twitch (object)
Array
One of
type
required
string
status
required
string
Enum: "ONLINE" "OFFLINE"
broadcasterId
string
broadcasterLogin
string
thumbnailUrl
string
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "services": [
    • "TWITCH"
    ]
}

Response samples

Content type
application/json
{
  • "shopId": "string",
  • "services": [
    • {
      • "type": "string",
      • "status": "ONLINE",
      • "broadcasterId": "string",
      • "broadcasterLogin": "string",
      • "thumbnailUrl": "string"
      }
    ]
}

Get streaming status

Returns streaming status for all services

Authorizations:
shopApiKey

Responses

Response Schema: application/json
shopId
required
string
required
Array of com.fourthwall.openapi.model.StreamingStatusV1.Service.Twitch (object)
Array
One of
type
required
string
status
required
string
Enum: "ONLINE" "OFFLINE"
broadcasterId
string
broadcasterLogin
string
thumbnailUrl
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "shopId": "string",
  • "services": [
    • {
      • "type": "string",
      • "status": "ONLINE",
      • "broadcasterId": "string",
      • "broadcasterLogin": "string",
      • "thumbnailUrl": "string"
      }
    ]
}

Thank yous

Get Thank You by id

Get Thank You details

Authorizations:
thankyou_readshopApiKey
path Parameters
thankYouId
required
string
Example: ty_EdJvIXu3SEiXe_QkPavHSA

Responses

Response Schema: application/json
id
required
string
mediaUrl
required
string
required
com.fourthwall.openapi.model.ThankYouContribution.Donation (object) or com.fourthwall.openapi.model.ThankYouContribution.GiftPurchase (object) or com.fourthwall.openapi.model.ThankYouContribution.Membership (object) or com.fourthwall.openapi.model.ThankYouContribution.Order (object)
One of
type
required
string
id
required
string
shopId
required
string
required
object (com.fourthwall.openapi.model.ThankYouContribution.Supporter)
email
required
string
username
string
message
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "ty_EdJvIXu3SEiXe_QkPavHSA",
  • "mediaUrl": "https://fourthwall.com/thankyou/ty_EdJvIXu3SEiXe_QkPavHSA",
  • "contribution": {
    • "type": "string",
    • "id": "don_Kpcjx4HIQ1e4bTIOjX9CsA",
    • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
    • "supporter": {
      • "email": "supporter@fourthwall.com",
      • "username": "Johnny123",
      • "message": "Sample message"
      }
    }
}

Twitch gift purchases

Get gift purchase by id

Returns gift purchase details by id

Authorizations:
shopApiKey
path Parameters
giftPurchaseId
required
string
Example: giv_EdJvIXu3SEiXe_QkPavHSA

Responses

Response Schema: application/json
id
required
string
friendlyId
required
string
shopId
required
string
required
object (com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1)
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.openapi.model.Image)
id
required
string
url
required
string
width
required
integer <int32>

The original width of the image in pixels.

height
required
integer <int32>

The original height of the image in pixels.

transformedUrl
required
string

Transformed URL with applied image processing (e.g., resizing, optimization)

required
object (com.fourthwall.openapi.model.GiftPurchaseV1.Amounts)
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
required
object (Money)
value
required
number >= 0
currency
required
string
email
required
string
username
string
message
string
quantity
required
integer <int32>
required
Array of com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Available (object) or com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Cancelled (object) or com.fourthwall.openapi.model.GiftPurchaseV1.Gift.ChangedToPromotion (object) or com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Redeemed (object)
Array
One of
status
required
string
id
required
string
object (com.fourthwall.openapi.model.GiftPurchaseV1.Winner)
email
string
username
string
selectedAt
required
string <date-time>
createdAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "giv_EdJvIXu3SEiXe_QkPavHSA",
  • "friendlyId": "D3XZFWPP",
  • "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  • "offer": {},
  • "amounts": {
    • "subtotal": {
      • "value": 10,
      • "currency": "USD"
      },
    • "tax": {
      • "value": 10,
      • "currency": "USD"
      },
    • "total": {
      • "value": 10,
      • "currency": "USD"
      },
    • "profit": {
      • "value": 10,
      • "currency": "USD"
      },
    • "prepaidShipping": {
      • "value": 10,
      • "currency": "USD"
      }
    },
  • "email": "supporter@fourthwall.com",
  • "username": "Johnny123",
  • "message": "Sample message",
  • "quantity": 0,
  • "gifts": [
    • {
      • "status": "string",
      • "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
      • "winner": {
        • "email": "supporter@fourthwall.com",
        • "username": "Johnny123",
        • "selectedAt": "2020-08-13T09:05:36.939Z"
        }
      }
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Webhooks

Subscribe to webhooks to receive real-time updates about your shop.

Get a webhook

Get a webhook

Authorizations:
webhook_readshopApiKey
path Parameters
webhookConfigurationId
required
string

Responses

Response Schema: application/json
id
required
string
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"
apiVersion
required
string
Value: "V1"
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "string",
  • "url": "string",
  • "allowedTypes": [
    • "ORDER_PLACED"
    ],
  • "apiVersion": "V1"
}

Update a webhook

Update a webhook

Authorizations:
webhook_writeshopApiKey
path Parameters
webhookConfigurationId
required
string
Request Body schema: application/json
required
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"

Responses

Response Schema: application/json
id
required
string
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"
apiVersion
required
string
Value: "V1"
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "url": "string",
  • "allowedTypes": [
    • "ORDER_PLACED"
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "url": "string",
  • "allowedTypes": [
    • "ORDER_PLACED"
    ],
  • "apiVersion": "V1"
}

Delete a webhook

Delete a webhook

Authorizations:
webhook_writeshopApiKey
path Parameters
webhookConfigurationId
required
string

Responses

Response Schema: */*
object

Get webhooks

Get webhooks

Authorizations:
webhook_readshopApiKey

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.WebhookConfigurationV1)
Array
id
required
string
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"
apiVersion
required
string
Value: "V1"
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "string",
      • "url": "string",
      • "allowedTypes": [
        • "ORDER_PLACED"
        ],
      • "apiVersion": "V1"
      }
    ],
  • "total": 0
}

Create a webhook

Create a webhook

Authorizations:
webhook_writeshopApiKey
Request Body schema: application/json
required
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"

Responses

Response Schema: application/json
id
required
string
url
required
string
allowedTypes
required
Array of strings
Items Enum: "ORDER_PLACED" "ORDER_UPDATED" "GIFT_PURCHASE" "PRODUCT_CREATED" "PRODUCT_UPDATED" "DONATION" "SUBSCRIPTION_PURCHASED" "SUBSCRIPTION_EXPIRED" "SUBSCRIPTION_CHANGED" "NEWSLETTER_SUBSCRIBED" "THANK_YOU_SENT" "GIFT_DRAW_STARTED" "GIFT_DRAW_ENDED" "PROMOTION_CREATED" "PROMOTION_UPDATED" "PROMOTION_STATUS_CHANGED" "PLATFORM_APP_DISCONNECTED"
apiVersion
required
string
Value: "V1"
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "url": "string",
  • "allowedTypes": [
    • "ORDER_PLACED"
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "url": "string",
  • "allowedTypes": [
    • "ORDER_PLACED"
    ],
  • "apiVersion": "V1"
}

BETA: Memberships

Manage memberships for your shop.

List membership tiers

Lists all tiers for the current shop

Authorizations:
memberships_readshopApiKey

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
imageUrl
string
Response Schema: */*
object

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "name": "string",
    • "imageUrl": "string"
    }
]

List members

Lists all members for the current shop

Authorizations:
memberships_readshopApiKey
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
Example: size=5

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.openapi.model.MembershipSupporterV1)
Array
id
required
string
email
required
string
nickname
required
string
createdAt
required
string <date-time>
required
com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Active (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Cancelled (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.None (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Suspended (object)
One of
type
required
string
required
object (com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Variant)
id
required
string
tierId
required
string
interval
required
string
Enum: "ANNUAL" "MONTHLY"
required
object (Money)
value
required
number >= 0
currency
required
string
total
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "string",
      • "email": "supporter@fourthwall.com",
      • "nickname": "string",
      • "createdAt": "2020-08-13T09:05:36.939Z",
      • "subscription": {
        • "type": "string",
        • "variant": {
          • "id": "string",
          • "tierId": "string",
          • "interval": "ANNUAL",
          • "amount": {
            • "value": 10,
            • "currency": "USD"
            }
          }
        }
      }
    ],
  • "total": 0
}

Get member

Gets a member by id

Authorizations:
memberships_readshopApiKey
path Parameters
id
required
string
Example: 123456

Responses

Response Schema: application/json
id
required
string
email
required
string
nickname
required
string
createdAt
required
string <date-time>
required
com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Active (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Cancelled (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.None (object) or com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Suspended (object)
One of
type
required
string
required
object (com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Variant)
id
required
string
tierId
required
string
interval
required
string
Enum: "ANNUAL" "MONTHLY"
required
object (Money)
value
required
number >= 0
currency
required
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "supporter@fourthwall.com",
  • "nickname": "string",
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "subscription": {
    • "type": "string",
    • "variant": {
      • "id": "string",
      • "tierId": "string",
      • "interval": "ANNUAL",
      • "amount": {
        • "value": 10,
        • "currency": "USD"
        }
      }
    }
}