Skip to main content
API docs by Redocly

Download OpenAPI specification:Download

OpenAPI documentation

Carts

Carts

Create cart

query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"
Request Body schema: application/json
required
required
Array of objects (com.fourthwall.app.headless.HeadlessCart.RequestItem)
Array
variantId
required
string <uuid>
quantity
required
integer <int32> [ 0 .. 1000 ]

Responses

Response Schema: application/json
id
required
string
required
Array of objects (com.fourthwall.app.headless.model.CartV1.CartItemV1)
Array
required
object (com.fourthwall.app.headless.model.CartProductVariantV1)
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
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)

required
object (com.fourthwall.app.headless.model.ProductStubV1)
id
required
string
name
required
string
slug
required
string
quantity
required
integer <int32>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "items": [
    • {
      • "variantId": "000009c2-0c75-0024-0000-09c20c750024",
      • "quantity": 1
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "items": [
    • {
      • "variant": {
        • "id": "string",
        • "name": "string",
        • "sku": "string",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "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": [],
        • "product": {
          • "id": "string",
          • "name": "string",
          • "slug": "string"
          }
        },
      • "quantity": 0
      }
    ]
}

Remove from cart

path Parameters
cartId
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"
Request Body schema: application/json
required
required
Array of objects (com.fourthwall.cart.usecase.CartRemoveFromCart.RequestItem) non-empty
Array (non-empty)
variantId
required
string <uuid>

Responses

Response Schema: application/json
id
required
string
required
Array of objects (com.fourthwall.app.headless.model.CartV1.CartItemV1)
Array
required
object (com.fourthwall.app.headless.model.CartProductVariantV1)
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
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)

required
object (com.fourthwall.app.headless.model.ProductStubV1)
id
required
string
name
required
string
slug
required
string
quantity
required
integer <int32>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "items": [
    • {
      • "variantId": "000009c2-0c75-0024-0000-09c20c750024"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "items": [
    • {
      • "variant": {
        • "id": "string",
        • "name": "string",
        • "sku": "string",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "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": [],
        • "product": {
          • "id": "string",
          • "name": "string",
          • "slug": "string"
          }
        },
      • "quantity": 0
      }
    ]
}

Change cart items quantity

path Parameters
cartId
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"
Request Body schema: application/json
required
required
Array of objects (com.fourthwall.cart.usecase.CartUpdateItemsQuantity.RequestItem) non-empty
Array (non-empty)
variantId
required
string <uuid>
quantity
required
integer <int32> [ 0 .. 1000 ]

Responses

Response Schema: application/json
id
required
string
required
Array of objects (com.fourthwall.app.headless.model.CartV1.CartItemV1)
Array
required
object (com.fourthwall.app.headless.model.CartProductVariantV1)
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
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)

required
object (com.fourthwall.app.headless.model.ProductStubV1)
id
required
string
name
required
string
slug
required
string
quantity
required
integer <int32>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "items": [
    • {
      • "variantId": "000009c2-0c75-0024-0000-09c20c750024",
      • "quantity": 0
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "items": [
    • {
      • "variant": {
        • "id": "string",
        • "name": "string",
        • "sku": "string",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "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": [],
        • "product": {
          • "id": "string",
          • "name": "string",
          • "slug": "string"
          }
        },
      • "quantity": 0
      }
    ]
}

Add to cart

path Parameters
cartId
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"
Request Body schema: application/json
required
required
Array of objects (com.fourthwall.cart.usecase.CartAdd.RequestItem)
Array
variantId
required
string <uuid>
quantity
required
integer <int32> [ 1 .. 10000 ]
recStrategy
string

Responses

Response Schema: application/json
id
required
string
required
Array of objects (com.fourthwall.app.headless.model.CartV1.CartItemV1)
Array
required
object (com.fourthwall.app.headless.model.CartProductVariantV1)
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
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)

required
object (com.fourthwall.app.headless.model.ProductStubV1)
id
required
string
name
required
string
slug
required
string
quantity
required
integer <int32>
Response Schema: */*
object

Request samples

Content type
application/json
{
  • "items": [
    • {
      • "variantId": "000009c2-0c75-0024-0000-09c20c750024",
      • "quantity": 1,
      • "recStrategy": "string"
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "items": [
    • {
      • "variant": {
        • "id": "string",
        • "name": "string",
        • "sku": "string",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "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": [],
        • "product": {
          • "id": "string",
          • "name": "string",
          • "slug": "string"
          }
        },
      • "quantity": 0
      }
    ]
}

Get cart by id

path Parameters
cartId
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"

Responses

Response Schema: application/json
id
required
string
required
Array of objects (com.fourthwall.app.headless.model.CartV1.CartItemV1)
Array
required
object (com.fourthwall.app.headless.model.CartProductVariantV1)
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
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)

required
object (com.fourthwall.app.headless.model.ProductStubV1)
id
required
string
name
required
string
slug
required
string
quantity
required
integer <int32>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "string",
  • "items": [
    • {
      • "variant": {
        • "id": "string",
        • "name": "string",
        • "sku": "string",
        • "unitPrice": {
          • "value": 10,
          • "currency": "USD"
          },
        • "compareAtPrice": {
          • "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": [],
        • "product": {
          • "id": "string",
          • "name": "string",
          • "slug": "string"
          }
        },
      • "quantity": 0
      }
    ]
}

Collections

Collections

Get all collections

Returns all collections

query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
page
integer <int32>
size
integer <int32>

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.app.headless.model.CollectionPublicV1)
Array
id
required
string
name
required
string
slug
required
string
description
required
string
object (com.fourthwall.support.paging.PageResult)
pageNumber
required
integer <int32>
pageSize
required
integer <int32>
elementsSize
required
integer <int32>
elementsTotal
required
integer <int32>
totalPages
required
integer <int32>
hasNextPage
required
boolean
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "col_b1EVARkUTcCTSfspQaXr1Q",
      • "name": "My collection",
      • "slug": "my-collection",
      • "description": "My collection description"
      }
    ],
  • "paging": {
    • "pageNumber": 0,
    • "pageSize": 0,
    • "elementsSize": 0,
    • "elementsTotal": 0,
    • "totalPages": 0,
    • "hasNextPage": true
    }
}

Get a collection

Returns a collection

path Parameters
slug
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx

Responses

Response Schema: application/json
id
required
string
name
required
string
slug
required
string
description
required
string
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "col_b1EVARkUTcCTSfspQaXr1Q",
  • "name": "My collection",
  • "slug": "my-collection",
  • "description": "My collection description"
}

Get products (offers) in a collection

Returns all products in the collection

path Parameters
slug
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"
page
integer <int32>
size
integer <int32>

Responses

Response Schema: application/json
required
Array of objects (com.fourthwall.app.headless.model.ProductV1)
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
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.app.headless.model.ProductVariantV1)
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
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)

createdAt
required
string <date-time>
updatedAt
required
string <date-time>
object (com.fourthwall.support.paging.PageResult)
pageNumber
required
integer <int32>
pageSize
required
integer <int32>
elementsSize
required
integer <int32>
elementsTotal
required
integer <int32>
totalPages
required
integer <int32>
hasNextPage
required
boolean
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "id": "string",
      • "name": "string",
      • "slug": "string",
      • "description": "string",
      • "state": {
        • "type": "string"
        },
      • "access": {
        • "type": "string"
        },
      • "images": [],
      • "variants": [
        • {
          • "id": "string",
          • "name": "string",
          • "sku": "string",
          • "unitPrice": {
            • "value": 10,
            • "currency": "USD"
            },
          • "compareAtPrice": {
            • "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": []
          }
        ],
      • "createdAt": "2020-08-13T09:05:36.939Z",
      • "updatedAt": "2020-08-13T09:05:36.939Z"
      }
    ],
  • "paging": {
    • "pageNumber": 0,
    • "pageSize": 0,
    • "elementsSize": 0,
    • "elementsTotal": 0,
    • "totalPages": 0,
    • "hasNextPage": true
    }
}

Products

Products

Get a product by slug

path Parameters
slug
required
string
query Parameters
storefront_token
string
Example: storefront_token=ptkn_xxxxxxxxxxxxxxxxxx
currency
string
Enum: "USD" "EUR" "CAD" "GBP" "AUD" "NZD" "SEK" "NOK" "DKK" "PLN" "INR" "JPY" "MYR" "SGD" "MXN"

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
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.app.headless.model.ProductVariantV1)
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
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)

createdAt
required
string <date-time>
updatedAt
required
string <date-time>
Response Schema: */*
object

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "state": {
    • "type": "string"
    },
  • "access": {
    • "type": "string"
    },
  • "images": [],
  • "variants": [
    • {
      • "id": "string",
      • "name": "string",
      • "sku": "string",
      • "unitPrice": {
        • "value": 10,
        • "currency": "USD"
        },
      • "compareAtPrice": {
        • "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": []
      }
    ],
  • "createdAt": "2020-08-13T09:05:36.939Z",
  • "updatedAt": "2020-08-13T09:05:36.939Z"
}