{ "openapi": "3.1.0", "info": { "title": "Fourthwall APIs", "description": "Service used for management of orders, carts, and payments.", "termsOfService": "https://fourthwall.com/terms-of-service", "contact": { "name": "Backend team", "url": "https://fourthwall.com", "email": "backend@fourthwall.com" }, "version": "unspecified" }, "externalDocs": { "description": "OpenAPI documentation", "url": "https://docs.fourthwall.com" }, "servers": [ { "url": "https://api.fourthwall.com", "description": "Production server" } ], "paths": { "/channel-api/v1.0/upload-url": { "post": { "tags": [ "Previews", "Shops" ], "summary": "Request a presigned upload URL for artwork", "operationId": "requestUploadUrl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.UploadUrlXRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.UploadUrlXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } } }, "/channel-api/v1.0/shops": { "get": { "tags": [ "Shops" ], "summary": "List shops attached to the agency", "operationId": "getShops", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.GetShopsXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } }, "post": { "tags": [ "Shops" ], "summary": "Create a shop", "operationId": "createShop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.CreateShopXRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.CreateShopXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } } }, "/channel-api/v1.0/previews": { "post": { "tags": [ "Previews", "Shops" ], "summary": "Generate preview images for a product (sync)", "operationId": "createPreview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.CreatePreviewXRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.CreatePreviewXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } } }, "/channel-api/v1.0/media/images": { "post": { "tags": [ "Previews", "Shops" ], "summary": "Register an uploaded image into the shop's media library", "description": "Returns a media image id to reference as a region's `imageId` in POST /previews.", "operationId": "registerMediaImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.RegisterMediaImageXRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.RegisterMediaImageXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } } }, "/channel-api/v1.0/channel/current": { "get": { "tags": [ "Channel" ], "summary": "Get current channel for channel API client", "operationId": "getCurrentChannel", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.fourthwall.app.channel.model.ChannelXResponse" } } } } }, "x-mint": { "mcp": { "enabled": true } } } } }, "components": { "schemas": { "com.fourthwall.app.channel.shop.model.UploadUrlXRequest": { "type": "object", "properties": { "contentType": { "type": "string", "description": "MIME type of the file. Only `image/png`, `image/jpeg`, `image/webp` and `image/gif` are accepted." }, "fileName": { "type": "string", "description": "Name of the file." }, "size": { "type": "integer", "format": "int64", "description": "Size of the file in bytes. Must match the `x-goog-content-length-range` header sent when uploading the bytes to `uploadUrl`." } }, "required": [ "contentType", "fileName", "size" ], "title": "Upload Url X Request" }, "com.fourthwall.app.channel.shop.model.UploadUrlXResponse": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "fileUrl": { "type": "string" } }, "required": [ "fileUrl", "uploadUrl" ], "title": "Upload Url X Response" }, "com.fourthwall.app.channel.shop.model.BusinessProfilePrefillXRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Business or brand name." }, "url": { "type": "string", "description": "Business website URL." }, "productDescription": { "type": "string", "description": "Short description of what the business sells." }, "mcc": { "type": "string", "description": "Merchant category code (4-digit MCC)." }, "supportEmail": { "type": "string", "description": "Customer support email address." }, "supportPhone": { "type": "string", "description": "Customer support phone number, in E.164 format." }, "supportUrl": { "type": "string", "description": "Customer support URL." } }, "title": "Business Profile Prefill X Request" }, "com.fourthwall.app.channel.shop.model.CompanyPrefillXRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Registered legal company name." }, "addressLine1": { "type": "string", "description": "Company address line 1." }, "addressLine2": { "type": "string", "description": "Company address line 2." }, "addressCity": { "type": "string", "description": "Company address city." }, "addressState": { "type": "string", "description": "Company address state / province / region." }, "addressPostalCode": { "type": "string", "description": "Company address postal / ZIP code." }, "addressCountry": { "type": "string", "description": "Two-letter ISO country code for the company address." }, "taxId": { "type": "string", "description": "Business tax ID (e.g. US EIN)." }, "vatId": { "type": "string", "description": "VAT identification number, where applicable." }, "registrationNumber": { "type": "string", "description": "Company registration number, where applicable." }, "structure": { "type": "string", "description": "Legal company structure (e.g. `sole_proprietorship`, `private_corporation`)." } }, "title": "Company Prefill X Request" }, "com.fourthwall.app.channel.shop.model.CreateShopXRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name for the new shop." }, "ownerEmail": { "type": "string", "description": "Email to invite as the shop owner. When set, an owner invitation is sent. Also used as the payout account email when `payout.prefill.individual.email` is absent." }, "payout": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.PayoutXRequest", "description": "Optional payout onboarding. When present, a connected payout account is provisioned for the shop and a hosted onboarding URL is returned as `payoutOnboardingUrl`." } }, "required": [ "name" ], "title": "Create Shop X Request" }, "com.fourthwall.app.channel.shop.model.IndividualPrefillXRequest": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Legal first name." }, "lastName": { "type": "string", "description": "Legal last name." }, "email": { "type": "string", "description": "Personal email address." }, "phone": { "type": "string", "description": "Phone number, in E.164 format." }, "dobDay": { "type": "integer", "format": "int32", "description": "Date of birth — day of month (1-31)." }, "dobMonth": { "type": "integer", "format": "int32", "description": "Date of birth — month (1-12)." }, "dobYear": { "type": "integer", "format": "int32", "description": "Date of birth — four-digit year." }, "addressLine1": { "type": "string", "description": "Street address line 1." }, "addressLine2": { "type": "string", "description": "Street address line 2." }, "addressCity": { "type": "string", "description": "Address city." }, "addressState": { "type": "string", "description": "Address state / province / region." }, "addressPostalCode": { "type": "string", "description": "Address postal / ZIP code." }, "addressCountry": { "type": "string", "description": "Two-letter ISO country code for the address." }, "ssnLast4": { "type": "string", "description": "Last 4 digits of the individual's US SSN." }, "idNumber": { "type": "string", "description": "Government-issued ID number (e.g. full SSN) where full verification is required." } }, "title": "Individual Prefill X Request" }, "com.fourthwall.app.channel.shop.model.PayoutPrefillXRequest": { "type": "object", "properties": { "businessProfile": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.BusinessProfilePrefillXRequest", "description": "Public-facing business details." }, "individual": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.IndividualPrefillXRequest", "description": "Personal details, used when `businessType` is `individual`." }, "company": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.CompanyPrefillXRequest", "description": "Company details, used when `businessType` is `company`." }, "externalAccount": { "type": "string", "description": "Bank account token to receive payouts (e.g. a tokenized bank account such as a `btok_…`)." } }, "title": "Payout Prefill X Request" }, "com.fourthwall.app.channel.shop.model.PayoutXRequest": { "type": "object", "properties": { "returnUrl": { "type": "string", "description": "HTTPS URL the creator is redirected back to when they leave the hosted payout onboarding (whether or not they finished). Returning here does NOT mean the account is ready — verify account status separately." }, "refreshUrl": { "type": "string", "description": "HTTPS URL the creator is redirected to when the onboarding link is no longer usable (expired or reused). The integration is expected to mint a fresh link and redirect again." }, "country": { "type": "string", "description": "Two-letter ISO country code for the payout account (e.g. `US`). Determines supported currencies and the verification fields required." }, "businessType": { "type": "string", "description": "Payout account business type: `individual` or `company`." }, "prefill": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.PayoutPrefillXRequest", "description": "Optional values used to pre-fill the hosted onboarding form so the creator has less to enter." } }, "required": [ "refreshUrl", "returnUrl" ], "title": "Payout X Request" }, "com.fourthwall.app.channel.shop.model.CreateShopXResponse": { "type": "object", "properties": { "shopId": { "type": "string", "description": "Id of the newly created shop." }, "shopName": { "type": "string", "description": "Display name of the created shop." }, "publicToken": { "type": "string", "description": "Public storefront token for the shop." }, "invitationEmail": { "type": "string", "description": "Email the owner invitation was sent to, if `ownerEmail` was provided." }, "invitationStatus": { "type": "string", "description": "Status of the owner invitation (e.g. `INVITED`, `FAILED`), or null when no email was provided." }, "payoutOnboardingUrl": { "type": "string", "description": "Hosted payout onboarding URL to redirect the creator to. Present only when `payout` was supplied. Single-use and short-lived." } }, "required": [ "publicToken", "shopId", "shopName" ], "title": "Create Shop X Response" }, "com.fourthwall.app.channel.shop.model.CreatePreviewXRequest": { "type": "object", "properties": { "productId": { "type": "string" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.PreviewRegionInputXRequest" } }, "colors": { "type": "array", "items": { "type": "string" } }, "sizes": { "type": "array", "items": { "type": "string" } } }, "required": [ "productId", "regions" ], "title": "Create Preview X Request" }, "com.fourthwall.app.channel.shop.model.PreviewRegionInputXRequest": { "type": "object", "properties": { "region": { "type": "string" }, "imageId": { "type": "string", "description": "Media image id from POST /media/images." }, "placementId": { "type": "string" }, "fillAllPlacements": { "type": "boolean" } }, "required": [ "imageId", "region" ], "title": "Preview Region Input X Request" }, "com.fourthwall.app.channel.shop.model.CreatePreviewXResponse": { "type": "object", "properties": { "pipelineId": { "type": "string" }, "customizationId": { "type": "string" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.PreviewImageXResponse" } } }, "required": [ "images", "pipelineId" ], "title": "Create Preview X Response" }, "com.fourthwall.app.channel.shop.model.PreviewImageXResponse": { "type": "object", "properties": { "url": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "style": { "type": "string" }, "color": { "type": "string" }, "size": { "type": "string" }, "region": { "type": "string" } }, "required": [ "color", "height", "style", "url", "width" ], "title": "Preview Image X Response" }, "com.fourthwall.app.channel.shop.model.RegisterMediaImageXRequest": { "type": "object", "properties": { "fileUrl": { "type": "string", "description": "URL of the uploaded artwork, as returned by POST /upload-url (`fileUrl`)." }, "width": { "type": "integer", "format": "int32", "description": "Pixel width of the uploaded artwork." }, "height": { "type": "integer", "format": "int32", "description": "Pixel height of the uploaded artwork." } }, "required": [ "fileUrl", "height", "width" ], "title": "Register Media Image X Request" }, "com.fourthwall.app.channel.shop.model.RegisterMediaImageXResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Media image id. Pass this as a region's `imageId` to POST /previews." }, "uri": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "required": [ "height", "id", "uri", "width" ], "title": "Register Media Image X Response" }, "com.fourthwall.app.channel.shop.model.GetShopsXResponse": { "type": "object", "properties": { "shops": { "type": "array", "description": "Shops attached to the agency this channel is credentialed for.", "items": { "$ref": "#/components/schemas/com.fourthwall.app.channel.shop.model.ShopSummaryXResponse" } } }, "required": [ "shops" ], "title": "Get Shops X Response" }, "com.fourthwall.app.channel.shop.model.ShopSummaryXResponse": { "type": "object", "properties": { "shopId": { "type": "string", "description": "Shop id." }, "name": { "type": "string", "description": "Shop display name." } }, "required": [ "name", "shopId" ], "title": "Shop Summary X Response" }, "com.fourthwall.app.channel.model.ChannelXResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "keycloakClientId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "createdAt", "id", "keycloakClientId", "name" ], "title": "Channel X Response" }, "com.fourthwall.openapi.model.OrderV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "friendlyId": { "type": "string", "example": "D3XZFWPP" }, "checkoutId": { "type": "string", "example": "ch_BV44UYrXQA2T_Xcf1288tw" }, "promotionId": { "type": "string", "example": "prm_EdJvIXu3SEiXe_QkPavHSA" }, "status": { "type": "string", "enum": [ "CONFIRMED", "PARTIALLY_IN_PRODUCTION", "IN_PRODUCTION", "PARTIALLY_SHIPPED", "SHIPPED", "PARTIALLY_DELIVERED", "DELIVERED", "CANCELLED", "COMPLETED" ] }, "email": { "type": "string", "example": "supporter@fourthwall.com" }, "emailMarketingOptIn": { "type": "boolean" }, "username": { "type": "string", "example": "Johnny123" }, "message": { "type": "string", "example": "Sample message" }, "amounts": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.OrderAmounts" }, "billing": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Billing" }, "shipping": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Shipping" }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferOrderV1" } }, "source": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source" }, "trackingParams": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.TrackingParams" }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom metadata passed during cart creation. Null for orders without metadata." }, "description": "Custom metadata passed during cart creation. Null for orders without metadata." }, "createdAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" } }, "title": "Order" }, "com.fourthwall.openapi.model.Address": { "properties": { "name": { "type": "string", "example": "Joe Doe" }, "address1": { "type": "string", "example": "Main Street 1" }, "address2": { "type": "string" }, "city": { "type": "string", "example": "San Francisco" }, "state": { "type": "string", "example": "CA" }, "country": { "type": "string", "example": "US" }, "zip": { "type": "string", "example": "12345" }, "phone": { "type": "string", "example": "123456789" } }, "title": "Address" }, "com.fourthwall.openapi.model.Image": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "url": { "type": "string", "format": "uri", "example": "https://fourthwall.com/image.png" }, "width": { "type": "integer", "format": "int32", "description": "The original width of the image in pixels.", "example": 800 }, "height": { "type": "integer", "format": "int32", "description": "The original height of the image in pixels.", "example": 600 }, "transformedUrl": { "type": "string", "format": "uri", "description": "Transformed URL with applied image processing (e.g., resizing, optimization)", "example": "https://fourthwall.com/image.png" } }, "title": "Image" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferOrderV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "name": { "type": "string", "example": "My t-shirt" }, "slug": { "type": "string", "example": "my-t-shirt" }, "description": { "type": "string", "example": "My t-shirt description" }, "primaryImage": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" }, "variant": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantWithQuantityV1" } }, "title": "Offer Order" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes": { "properties": { "description": { "type": "string", "example": "Black, L" }, "color": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color" }, "size": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size" } }, "title": "Attributes" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Color": { "properties": { "name": { "type": "string", "example": "Black" }, "swatch": { "type": "string", "example": "#000000" } }, "title": "Color" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes.Size": { "properties": { "name": { "type": "string", "example": "L" } }, "title": "Size" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions": { "properties": { "length": { "type": "number", "example": 1 }, "width": { "type": "number", "example": 2 }, "height": { "type": "number", "example": 3 }, "unit": { "type": "string", "example": "cm" } }, "title": "Dimensions" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantWithQuantityV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "name": { "type": "string", "example": "My t-shirt - Black, L" }, "sku": { "type": "string", "example": "WDEK-DRE200L" }, "unitPrice": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "unitCost": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "compareAtPrice": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "attributes": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes" }, "quantity": { "type": "integer", "format": "int32", "example": 5 }, "price": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "cost": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "weight": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight" }, "dimensions": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions" } }, "title": "Offer Variant With Quantity" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight": { "properties": { "value": { "type": "number", "example": 1 }, "unit": { "type": "string", "example": "kg" } }, "title": "Weight" }, "com.fourthwall.openapi.model.OrderV1.Billing": { "properties": { "address": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Address" } }, "title": "Billing" }, "com.fourthwall.openapi.model.OrderV1.GiftCard": { "properties": { "code": { "type": "string" }, "amountUsed": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Gift Card" }, "com.fourthwall.openapi.model.OrderV1.OrderAmounts": { "properties": { "subtotal": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "shipping": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "tax": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "donation": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "discount": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "giftCards": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.GiftCard" } }, "total": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Order Amounts" }, "com.fourthwall.openapi.model.OrderV1.Shipping": { "properties": { "address": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Address" } }, "title": "Shipping" }, "com.fourthwall.openapi.model.OrderV1.Source": { "discriminator": { "propertyName": "type", "mapping": { "ORDER": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source.Order", "SAMPLES_ORDER": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source.SamplesOrder", "TWITCH_GIFT_REDEMPTION": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source.TwitchGiftRedemption", "GIVEAWAY_LINKS": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source.GiveawayLinks" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Source" }, "com.fourthwall.openapi.model.OrderV1.Source.GiveawayLinks": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source" }, { "type": "object", "properties": { "giftId": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "GIVEAWAY_LINKS" } } } ], "title": "Giveaway Links" }, "com.fourthwall.openapi.model.OrderV1.Source.Order": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ORDER" } } } ], "title": "Order" }, "com.fourthwall.openapi.model.OrderV1.Source.SamplesOrder": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source" }, { "type": "object", "properties": { "type": { "type": "string", "const": "SAMPLES_ORDER" } } } ], "title": "Samples Order" }, "com.fourthwall.openapi.model.OrderV1.Source.TwitchGiftRedemption": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1.Source" }, { "type": "object", "properties": { "giftPurchaseId": { "type": "string", "example": "giv_EdJvIXu3SEiXe_QkPavHSA" }, "giftId": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "TWITCH_GIFT_REDEMPTION" } } } ], "title": "Twitch Gift Redemption" }, "com.fourthwall.openapi.model.OrderV1.TrackingParams": { "properties": { "fbc": { "type": "string" }, "fbp": { "type": "string" }, "utm_source": { "type": "string" }, "utm_medium": { "type": "string" }, "utm_campaign": { "type": "string" }, "utm_content": { "type": "string" }, "utm_term": { "type": "string" } }, "title": "Tracking Params" }, "com.fourthwall.support.money.Money": { "properties": { "currency": { "type": "string", "enum": [ "USD", "EUR", "CAD", "GBP", "AUD", "NZD", "SEK", "NOK", "DKK", "PLN", "INR", "JPY", "MYR", "SGD", "MXN", "BRL", "CHF" ] }, "zero": { "type": "boolean" }, "negative": { "type": "boolean" }, "currencyScale": { "type": "integer", "format": "int32" }, "moreThanZero": { "type": "boolean" }, "lessThanZero": { "type": "boolean" }, "zeroOrLess": { "type": "boolean" } }, "title": "Money" }, "com.fourthwall.openapi.model.OrderUpdatedV1": { "properties": { "order": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderV1" }, "update": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update" } }, "title": "Order Updated" }, "com.fourthwall.openapi.model.OrderUpdatedV1.Update": { "discriminator": { "propertyName": "type", "mapping": { "STATUS": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update.Status", "SHIPPING.ADDRESS": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update.ShippingAddress", "EMAIL": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update.Email" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Update" }, "com.fourthwall.openapi.model.OrderUpdatedV1.Update.Email": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update" }, { "type": "object", "properties": { "type": { "type": "string", "const": "EMAIL" } } } ], "title": "Email" }, "com.fourthwall.openapi.model.OrderUpdatedV1.Update.ShippingAddress": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update" }, { "type": "object", "properties": { "type": { "type": "string", "const": "SHIPPING.ADDRESS" } } } ], "title": "Shipping Address" }, "com.fourthwall.openapi.model.OrderUpdatedV1.Update.Status": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OrderUpdatedV1.Update" }, { "type": "object", "properties": { "type": { "type": "string", "const": "STATUS" } } } ], "title": "Status" }, "com.fourthwall.openapi.model.GiftPurchaseV1": { "properties": { "id": { "type": "string", "example": "giv_EdJvIXu3SEiXe_QkPavHSA" }, "friendlyId": { "type": "string", "example": "D3XZFWPP" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "offer": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1" }, "amounts": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Amounts" }, "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "message": { "type": "string", "example": "Sample message" }, "quantity": { "type": "integer", "format": "int32" }, "gifts": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" } }, "createdAt": { "type": "string", "format": "date-time" } }, "title": "Gift Purchase" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Amounts": { "properties": { "subtotal": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "tax": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "total": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "profit": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "prepaidShipping": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Amounts" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Gift": { "discriminator": { "propertyName": "status", "mapping": { "REDEEMED": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Redeemed", "AVAILABLE": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Available", "CANCELLED": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Cancelled", "CHANGED_TO_PROMOTION": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift.ChangedToPromotion" } }, "properties": { "status": { "type": "string" } }, "required": [ "status" ], "title": "Gift" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Available": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "AVAILABLE" } } } ], "title": "Available" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Cancelled": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "CANCELLED" } } } ], "title": "Cancelled" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Gift.ChangedToPromotion": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "promotionId": { "type": "string", "example": "prm_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "CHANGED_TO_PROMOTION" } } } ], "title": "Changed To Promotion" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Gift.Redeemed": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "orderId": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "orderFriendlyId": { "type": "string", "example": "D3XZFWPP" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "REDEEMED" } } } ], "title": "Redeemed" }, "com.fourthwall.openapi.model.GiftPurchaseV1.Winner": { "properties": { "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "selectedAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" } }, "title": "Winner" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "name": { "type": "string", "example": "My t-shirt" }, "slug": { "type": "string", "example": "my-t-shirt" }, "description": { "type": "string", "example": "My t-shirt description" }, "primaryImage": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" } }, "title": "Offer Gift Purchase" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferFullV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "name": { "type": "string", "example": "My t-shirt" }, "slug": { "type": "string", "example": "my-t-shirt" }, "description": { "type": "string", "example": "My t-shirt description" }, "type": { "type": "string", "enum": [ "STANDARD", "GIFT_CARD", "UNKNOWN" ] }, "state": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1" }, "access": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1" }, "thumbnailImage": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" } }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantV1" } }, "additionalInformation": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAdditionalInformationV1" }, "sizeGuide": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferSizeGuideV1" }, "digitalFiles": { "type": "array", "description": "Digital files attached to this offer. Only present for digital offers.", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.offer.DigitalFileV1" } }, "createdAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" } }, "title": "Offer Full" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1": { "discriminator": { "propertyName": "type", "mapping": { "PUBLIC": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Public", "HIDDEN": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Hidden", "PRIVATE": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Private", "ARCHIVED": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Archived" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Offer Access" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Archived": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ARCHIVED" } } } ], "title": "Archived" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Hidden": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "HIDDEN" } } } ], "title": "Hidden" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Private": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "PRIVATE" } } } ], "title": "Private" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1.Public": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferAccessV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "PUBLIC" } } } ], "title": "Public" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferAdditionalInformationV1": { "properties": { "sizeAndFit": { "type": "string" }, "guaranteeAndReturns": { "type": "string" }, "moreDetails": { "type": "string" } }, "title": "Offer Additional Information" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferSizeGuideV1": { "properties": { "previewUrl": { "type": "string" }, "fileUrl": { "type": "string" }, "description": { "type": "string" }, "fitGuideDescription": { "type": "string" }, "fitGuideUrls": { "type": "array", "items": { "type": "string" } } }, "title": "Offer Size Guide" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1": { "discriminator": { "propertyName": "type", "mapping": { "AVAILABLE": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.Available", "SOLD_OUT": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.SoldOut" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Offer State" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.Available": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "AVAILABLE" } } } ], "title": "Available" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1.SoldOut": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferStateV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "SOLD_OUT" } } } ], "title": "Sold Out" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.OfferVariantV1": { "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "name": { "type": "string", "example": "My t-shirt - Black, L" }, "sku": { "type": "string", "example": "WDEK-DRE200L" }, "unitPrice": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "compareAtPrice": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "unitCost": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "attributes": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Attributes" }, "creatorDeclaredCost": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "stock": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock" }, "weight": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Weight" }, "dimensions": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Dimensions" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" } }, "thumbnailImage": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.Image" } }, "title": "Offer Variant" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock": { "discriminator": { "propertyName": "type", "mapping": { "UNLIMITED": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Unlimited", "LIMITED": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Limited" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Stock" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Limited": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock" }, { "type": "object", "properties": { "inStock": { "type": "integer", "format": "int32", "example": 5 } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "LIMITED" } } } ], "title": "Limited" }, "com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock.Unlimited": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferVariantAbstractV1.Stock" }, { "type": "object", "properties": { "type": { "type": "string", "const": "UNLIMITED" } } } ], "title": "Unlimited" }, "com.fourthwall.openapi.model.offer.DigitalFileV1": { "description": "A digital file attached to an offer", "properties": { "uri": { "type": "string", "description": "The file URI", "example": "https://storage.googleapis.com/bucket/shop/offer/file" }, "name": { "type": "string", "description": "The file name", "example": "my-ebook.pdf" }, "fileSize": { "type": "string", "description": "Human-readable file size", "example": "15.4 MB" }, "mediaType": { "type": "string", "description": "MIME type of the file", "example": "application/pdf" } }, "title": "Digital File" }, "com.fourthwall.openapi.model.OfferUpdatedV1": { "properties": { "product": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferFullV1" } }, "title": "Offer Updated" }, "com.fourthwall.openapi.model.DonationV1": { "properties": { "id": { "type": "string", "example": "don_Kpcjx4HIQ1e4bTIOjX9CsA" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "status": { "type": "string", "enum": [ "OPEN", "COMPLETED", "ABANDONED", "CANCELLED", "FAILED" ] }, "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "message": { "type": "string", "example": "Sample message" }, "amounts": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Amounts" }, "createdAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" } }, "title": "Donation" }, "com.fourthwall.openapi.model.DonationV1.Amounts": { "properties": { "total": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Amounts" }, "com.fourthwall.openapi.model.MembershipSupporterV1": { "properties": { "id": { "type": "string" }, "email": { "type": "string", "example": "supporter@fourthwall.com" }, "nickname": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" }, "subscription": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription" } }, "title": "Membership Supporter" }, "com.fourthwall.openapi.model.MembershipSupporterV1.Subscription": { "discriminator": { "propertyName": "type", "mapping": { "ACTIVE": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Active", "CANCELLED": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Cancelled", "SUSPENDED": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Suspended", "NONE": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.None" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Subscription" }, "com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Active": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription" }, { "type": "object", "properties": { "variant": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipTierVariantV1" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "ACTIVE" } } } ], "title": "Active" }, "com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Cancelled": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription" }, { "type": "object", "properties": { "variant": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipTierVariantV1" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "CANCELLED" } } } ], "title": "Cancelled" }, "com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.None": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription" }, { "type": "object", "properties": { "type": { "type": "string", "const": "NONE" } } } ], "title": "None" }, "com.fourthwall.openapi.model.MembershipSupporterV1.Subscription.Suspended": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipSupporterV1.Subscription" }, { "type": "object", "properties": { "variant": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.MembershipTierVariantV1" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "SUSPENDED" } } } ], "title": "Suspended" }, "com.fourthwall.openapi.model.MembershipTierVariantV1": { "properties": { "id": { "type": "string" }, "tierId": { "type": "string" }, "interval": { "type": "string", "enum": [ "ANNUAL", "MONTHLY" ] }, "amount": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "offerId": { "type": "string" } }, "title": "Membership Tier Variant" }, "com.fourthwall.openapi.model.NewsletterSubscribedV1": { "properties": { "email": { "type": "string" } }, "title": "Newsletter Subscribed" }, "com.fourthwall.openapi.model.ThankYouV1": { "properties": { "id": { "type": "string", "example": "ty_EdJvIXu3SEiXe_QkPavHSA" }, "mediaUrl": { "type": "string", "example": "https://fourthwall.com/thankyou/ty_EdJvIXu3SEiXe_QkPavHSA" }, "contribution": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution" } }, "title": "Thank You" }, "com.fourthwall.openapi.model.ThankYouContribution": { "discriminator": { "propertyName": "type", "mapping": { "ORDER": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Order", "DONATION": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Donation", "GIFT_PURCHASE": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.GiftPurchase", "MEMBERSHIP_PAYMENT_CHARGE": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Membership" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Thank You Contribution" }, "com.fourthwall.openapi.model.ThankYouContribution.Donation": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution" }, { "type": "object", "properties": { "id": { "type": "string", "example": "don_Kpcjx4HIQ1e4bTIOjX9CsA" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "supporter": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Supporter" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "DONATION" } } } ], "title": "Donation" }, "com.fourthwall.openapi.model.ThankYouContribution.GiftPurchase": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution" }, { "type": "object", "properties": { "id": { "type": "string", "example": "giv_EdJvIXu3SEiXe_QkPavHSA" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "supporter": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Supporter" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "GIFT_PURCHASE" } } } ], "title": "Gift Purchase" }, "com.fourthwall.openapi.model.ThankYouContribution.Membership": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution" }, { "type": "object", "properties": { "id": { "type": "string", "example": "mpc_EdJvIXu3SEiXe_QkPavHSA" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "supporter": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Supporter" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "MEMBERSHIP_PAYMENT_CHARGE" } } } ], "title": "Membership" }, "com.fourthwall.openapi.model.ThankYouContribution.Order": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution" }, { "type": "object", "properties": { "id": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "supporter": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.ThankYouContribution.Supporter" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "ORDER" } } } ], "title": "Order" }, "com.fourthwall.openapi.model.ThankYouContribution.Supporter": { "properties": { "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "message": { "type": "string", "example": "Sample message" } }, "title": "Supporter" }, "com.fourthwall.openapi.model.GiftDraftV1": { "properties": { "id": { "type": "string", "example": "gdr_EdJvIXu3SEiXe_QkPavHSA" }, "type": { "type": "string", "enum": [ "INITIAL", "REDO" ] }, "giveawayId": { "type": "string", "example": "giv_EdJvIXu3SEiXe_QkPavHSA" }, "giveawayFriendlyId": { "type": "string", "example": "D3XZFWPP" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "offer": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.OfferAbstractV1.OfferGiftPurchaseV1" }, "amounts": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.DonationV1.Amounts" }, "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "message": { "type": "string", "example": "Sample message" }, "gifts": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" } }, "createdAt": { "type": "string", "format": "date-time" }, "durationSeconds": { "type": "integer", "format": "int64" } }, "title": "Gift Draft" }, "com.fourthwall.openapi.model.GiftDraftV1.Amounts": { "properties": { "subtotal": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "total": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Amounts" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift": { "discriminator": { "propertyName": "status", "mapping": { "REDEEMED": "#/components/schemas/com.fourthwall.openapi.model.GiftDraftV1.Gift.Redeemed", "AVAILABLE": "#/components/schemas/com.fourthwall.openapi.model.GiftDraftV1.Gift.Available", "CANCELLED": "#/components/schemas/com.fourthwall.openapi.model.GiftDraftV1.Gift.Cancelled", "CHANGED_TO_PROMOTION": "#/components/schemas/com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToPromotion", "CHANGED_TO_GIFT_CARD": "#/components/schemas/com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToGiftCard" } }, "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "status" ], "title": "Gift" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift.Available": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "AVAILABLE" } } } ], "title": "Available" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift.Cancelled": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "CANCELLED" } } } ], "title": "Cancelled" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToGiftCard": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "giftCardId": { "type": "string", "example": "gcrd_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "CHANGED_TO_GIFT_CARD" } } } ], "title": "Changed To Gift Card" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift.ChangedToPromotion": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "promotionId": { "type": "string", "example": "prm_EdJvIXu3SEiXe_QkPavHSA" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "CHANGED_TO_PROMOTION" } } } ], "title": "Changed To Promotion" }, "com.fourthwall.openapi.model.GiftDraftV1.Gift.Redeemed": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Gift" }, { "type": "object", "properties": { "id": { "type": "string", "example": "gft_EdJvIXu3SEiXe_QkPavHSA" }, "orderId": { "type": "string", "example": "00aa4abd-5778-4199-8161-0b49b2f212e5" }, "orderFriendlyId": { "type": "string", "example": "D3XZFWPP" }, "winner": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.GiftPurchaseV1.Winner" } } }, { "type": "object", "properties": { "status": { "type": "string", "const": "REDEEMED" } } } ], "title": "Redeemed" }, "com.fourthwall.openapi.model.GiftDraftV1.Winner": { "properties": { "email": { "type": "string", "example": "supporter@fourthwall.com" }, "username": { "type": "string", "example": "Johnny123" }, "selectedAt": { "type": "string", "format": "date-time", "example": "2020-08-13T09:05:36.939Z" }, "redeemUri": { "type": "string", "format": "uri" } }, "title": "Winner" }, "com.fourthwall.openapi.model.promotions.PromotionV1": { "discriminator": { "propertyName": "type", "mapping": { "SHOP_SINGLE": "#/components/schemas/com.fourthwall.openapi.model.promotions.SingleShopPromotionV1", "SHOP_MULTI": "#/components/schemas/com.fourthwall.openapi.model.promotions.MultiShopPromotionV1", "SHOP_AUTO_APPLYING": "#/components/schemas/com.fourthwall.openapi.model.promotions.AutoApplyingShopPromotionV1", "MEMBERSHIPS_SINGLE": "#/components/schemas/com.fourthwall.openapi.model.promotions.SingleMembershipsPromotionV1", "MEMBERSHIPS_MULTI": "#/components/schemas/com.fourthwall.openapi.model.promotions.MultiMembershipsPromotionV1" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion" }, "com.fourthwall.openapi.model.promotions.AutoApplyingShopPromotionV1": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionV1" }, { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "code": { "type": "string" }, "discount": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] }, "requirements": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop" }, "usageCount": { "type": "integer", "format": "int32" }, "limits": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionLimitsV1" }, "appliesTo": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, "type": { "type": "string", "const": "SHOP_AUTO_APPLYING" } } } ], "title": "Auto Applying Shop Promotion" }, "com.fourthwall.openapi.model.promotions.MultiMembershipsPromotionV1": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionV1" }, { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "codes": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.MultiPromoSubCodeV1" } }, "discount": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] }, "requirements": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Memberships" }, "usageCount": { "type": "integer", "format": "int32" }, "subscriptionType": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1" }, "tiers": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1" }, "type": { "type": "string", "const": "MEMBERSHIPS_MULTI" } } } ], "title": "Multi Memberships Promotion" }, "com.fourthwall.openapi.model.promotions.MultiPromoSubCodeV1": { "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "usageCount": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] } }, "title": "Multi Promo Sub Code" }, "com.fourthwall.openapi.model.promotions.MultiShopPromotionV1": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionV1" }, { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "codes": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.MultiPromoSubCodeV1" } }, "discount": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] }, "requirements": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop" }, "limits": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionLimitsV1" }, "usageCount": { "type": "integer", "format": "int32" }, "appliesTo": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, "type": { "type": "string", "const": "SHOP_MULTI" } } } ], "title": "Multi Shop Promotion" }, "com.fourthwall.openapi.model.promotions.PromotionLimitsV1": { "properties": { "maximumUsesNumber": { "type": "integer", "format": "int32" }, "oneUsePerCustomer": { "type": "boolean" } }, "title": "Promotion Limits" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1": { "discriminator": { "propertyName": "type", "mapping": { "MEMBERSHIPS_PERCENTAGE": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1.Percentage" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion Memberships Discount Type" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1.Percentage": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1" }, { "type": "object", "properties": { "percentage": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "MEMBERSHIPS_PERCENTAGE" } } } ], "title": "Percentage" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1": { "discriminator": { "propertyName": "type", "mapping": { "ALL": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.AllMembers", "MONTHLY": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.MonthlyMembersOnly", "ANNUAL": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.AnnualMembersOnly" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion Memberships Subscription Type Applies To" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.AllMembers": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ALL" } } } ], "title": "All Members" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.AnnualMembersOnly": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ANNUAL" } } } ], "title": "Annual Members Only" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1.MonthlyMembersOnly": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "MONTHLY" } } } ], "title": "Monthly Members Only" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1": { "discriminator": { "propertyName": "type", "mapping": { "ALL": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1.AllTiers", "SELECTED": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1.SelectedTiers" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion Memberships Tiers Applies To" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1.AllTiers": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ALL" } } } ], "title": "All Tiers" }, "com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1.SelectedTiers": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1" }, { "type": "object", "properties": { "tiersIds": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "SELECTED" } } } ], "title": "Selected Tiers" }, "com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Memberships": { "properties": { "newMembersOnly": { "type": "boolean" } }, "title": "Memberships" }, "com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop": { "properties": { "minimumOrderValue": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" } }, "title": "Shop" }, "com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1": { "discriminator": { "propertyName": "type", "mapping": { "ENTIRE_ORDER": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrder", "SELECTED_PRODUCTS": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.SelectedProducts", "ENTIRE_ORDER_WITH_EXCLUDED_PRODUCTS": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrderWithExcludedProducts" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion Shop Applies To" }, "com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrder": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ENTIRE_ORDER" } } } ], "title": "Entire Order" }, "com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.EntireOrderWithExcludedProducts": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, { "type": "object", "properties": { "excludedProducts": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "ENTIRE_ORDER_WITH_EXCLUDED_PRODUCTS" } } } ], "title": "Entire Order With Excluded Products" }, "com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1.SelectedProducts": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "string" } }, "oncePerOrder": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "SELECTED_PRODUCTS" } } } ], "title": "Selected Products" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1": { "discriminator": { "propertyName": "type", "mapping": { "PERCENTAGE": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.Percentage", "FLAT_RATE": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FixedAmount", "FREE_SHIPPING": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeShipping", "FREE_PRODUCTS": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Promotion Shop Discount Type" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FixedAmount": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, { "type": "object", "properties": { "money": { "$ref": "#/components/schemas/com.fourthwall.support.money.Money" }, "freeShipping": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "FLAT_RATE" } } } ], "title": "Fixed Amount" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, { "type": "object", "properties": { "freeProductsType": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type" }, "freeShipping": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "FREE_PRODUCTS" } } } ], "title": "Free Products" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.AutoAddedFreeProduct": { "properties": { "variantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "title": "Auto Added Free Product" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.ManuallyAddedFreeProduct": { "properties": { "availableVariantIds": { "type": "array", "items": { "type": "string" } }, "quantity": { "type": "integer", "format": "int32" } }, "title": "Manually Added Free Product" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type": { "discriminator": { "propertyName": "type", "mapping": { "AUTO_ADDED": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type.AutoAdded", "MANUALLY_ADDED": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type.ManuallyAdded" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Type" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type.AutoAdded": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type" }, { "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.AutoAddedFreeProduct" } } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "AUTO_ADDED" } } } ], "title": "Auto Added" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type.ManuallyAdded": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.Type" }, { "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeProducts.ManuallyAddedFreeProduct" } } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "MANUALLY_ADDED" } } } ], "title": "Manually Added" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.FreeShipping": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, { "type": "object", "properties": { "lowestOnly": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "FREE_SHIPPING" } } } ], "title": "Free Shipping" }, "com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1.Percentage": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, { "type": "object", "properties": { "percentage": { "type": "number" }, "shippingOption": { "type": "string", "enum": [ "Included", "Excluded", "Free", "FreeLowestOnly" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "PERCENTAGE" } } } ], "title": "Percentage" }, "com.fourthwall.openapi.model.promotions.SingleMembershipsPromotionV1": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionV1" }, { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "discount": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsDiscountTypeV1" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] }, "requirements": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Memberships" }, "usageCount": { "type": "integer", "format": "int32" }, "subscriptionType": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsSubscriptionTypeAppliesToV1" }, "tiers": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionMembershipsTiersAppliesToV1" }, "type": { "type": "string", "const": "MEMBERSHIPS_SINGLE" } } } ], "title": "Single Memberships Promotion" }, "com.fourthwall.openapi.model.promotions.SingleShopPromotionV1": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionV1" }, { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "discount": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopDiscountTypeV1" }, "status": { "type": "string", "enum": [ "Live", "Ended", "Archived", "AllUsed" ] }, "requirements": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionRequirementsV1.Shop" }, "usageCount": { "type": "integer", "format": "int32" }, "limits": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionLimitsV1" }, "appliesTo": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.promotions.PromotionShopAppliesToV1" }, "type": { "type": "string", "const": "SHOP_SINGLE" } } } ], "title": "Single Shop Promotion" }, "com.fourthwall.openapi.model.PlatformAppDisconnectedV1": { "properties": { "appId": { "type": "string", "example": "apps.test_app" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" } }, "title": "Platform App Disconnected" }, "com.fourthwall.openapi.model.CollectionV1": { "properties": { "id": { "type": "string", "example": "col_b1EVARkUTcCTSfspQaXr1Q" }, "shopId": { "type": "string", "example": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb" }, "name": { "type": "string", "example": "My collection" }, "slug": { "type": "string", "example": "my-collection" }, "description": { "type": "string", "example": "My collection description" }, "available": { "type": "boolean" }, "state": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1" }, "offerIds": { "type": "array", "items": { "type": "string" } } }, "title": "Collection" }, "com.fourthwall.openapi.model.CollectionStateV1": { "description": "Collection state", "discriminator": { "propertyName": "type", "mapping": { "PUBLIC": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1.Public", "HIDDEN": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1.Hidden", "PRIVATE": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1.Private", "ARCHIVED": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1.Archived" } }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "title": "Collection State" }, "com.fourthwall.openapi.model.CollectionStateV1.Archived": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1" }, { "type": "object", "properties": { "type": { "type": "string", "const": "ARCHIVED" } } } ], "description": "Archived collection state", "title": "Archived" }, "com.fourthwall.openapi.model.CollectionStateV1.Hidden": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1" }, { "type": "object", "properties": { "available": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "HIDDEN" } } } ], "description": "Hidden collection state", "title": "Hidden" }, "com.fourthwall.openapi.model.CollectionStateV1.Private": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1" }, { "type": "object", "properties": { "available": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "PRIVATE" } } } ], "description": "Private collection state", "title": "Private" }, "com.fourthwall.openapi.model.CollectionStateV1.Public": { "allOf": [ { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CollectionStateV1" }, { "type": "object", "properties": { "available": { "type": "boolean" } } }, { "type": "object", "properties": { "type": { "type": "string", "const": "PUBLIC" } } } ], "description": "Public collection state", "title": "Public" }, "com.fourthwall.openapi.model.CartAbandonedV1": { "properties": { "cartId": { "type": "string" }, "shopId": { "type": "string" }, "email": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CartAbandonedV1.CartItem" } }, "cartOrigin": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "cartCreatedAt": { "type": "string", "format": "date-time" }, "cartUpdatedAt": { "type": "string", "format": "date-time" }, "checkout": { "$ref": "#/components/schemas/com.fourthwall.openapi.model.CartAbandonedV1.CheckoutContext" } }, "title": "Cart Abandoned" }, "com.fourthwall.openapi.model.CartAbandonedV1.CartItem": { "properties": { "offerVariantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "title": "Cart Item" }, "com.fourthwall.openapi.model.CartAbandonedV1.CheckoutContext": { "properties": { "checkoutId": { "type": "string" }, "status": { "type": "string" }, "currentStep": { "type": "string" }, "checkoutCreatedAt": { "type": "string", "format": "date-time" }, "checkoutUpdatedAt": { "type": "string", "format": "date-time" } }, "title": "Checkout Context" } } } }