Fourthwall Open API

https://docs.fourthwall.com/open-api
Admin
The Fourthwall Open API allows developers to programmatically access and manage store data,...
Tokens:126,246
Snippets:317
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Webhook Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON structure for a webhook event response, indicating an order placement.

```APIDOC
{
  "id": "string",
  "url": "string",
  "allowedTypes": [
    "ORDER_PLACED"
  ],
  "apiVersion": "V1"
}
```

--------------------------------

### Webhook Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON structure for a webhook event response, indicating an order placement.

```APIDOC
{
  "id": "string",
  "url": "string",
  "allowedTypes": [
    "ORDER_PLACED"
  ],
  "apiVersion": "V1"
}
```

--------------------------------

### Webhook Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON structure for a webhook event response, indicating an order placement.

```APIDOC
{
  "id": "string",
  "url": "string",
  "allowedTypes": [
    "ORDER_PLACED"
  ],
  "apiVersion": "V1"
}
```

--------------------------------

### Product Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON response structure for a product, detailing its ID, name, description, state, access, images, variants, and additional information.

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

--------------------------------

### Get Webhook Secret Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON structure for retrieving a webhook secret.

```APIDOC
{
  "secret": "e3f93c7c-c92b-4b8f-a9b1-5b70e0891abc"
}
```

--------------------------------

### Get Webhook Secret Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON structure for retrieving a webhook secret.

```APIDOC
{
  "secret": "e3f93c7c-c92b-4b8f-a9b1-5b70e0891abc"
}
```

--------------------------------

### Product Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON response structure for a product, detailing its ID, name, description, state, access, images, variants, and additional information.

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

--------------------------------

### Get Webhook Secret Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON structure for retrieving a webhook secret.

```APIDOC
{
  "secret": "e3f93c7c-c92b-4b8f-a9b1-5b70e0891abc"
}
```

--------------------------------

### API Request and Response Samples

Source: https://docs.fourthwall.com/open-api/-beta/index

Provides examples of JSON payloads for API requests and responses. The request sample demonstrates how to set product availability, while the response sample illustrates the structure of a successful confirmation, including details like IDs, amounts, and item information.

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

---

### Request samples

* Payload

Content type

application/json

Copy

```json
{
  "available": true
}
```
```

--------------------------------

### Get Giveaway Links by Package ID (APIDOC)

Source: https://docs.fourthwall.com/open-api/-docs/open-api

Retrieves all giveaway links for a specific package ID. Requires basic authentication. Includes an example for the packageId parameter.

```APIDOC
/open-api/v1.0/giveaway-links/packages/{packageId}:
  get:
    tags:
      - Giveaway links
    summary: Get giveaway links
    description: Returns all giveaway links for packageId
    externalDocs:
      url: >-
        https://docs.fourthwall.com/open-api/#tag/Giveaway-links/operation/getGiveawayLinksByPackageId
    operationId: getGiveawayLinksByPackageId
    parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        example: 00aa4abd-5778-4199-8161-0b49b2f212e5
    responses:
      '200':
        description: OK
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/com.fourthwall.openapi.model.GiveawayLinksV1
      '400':
        description: Bad Request
        content:
          '*/*':
            schema:
              type: object
    security:
      - basicAuth: []
```

--------------------------------

### API Request and Response Samples

Source: https://docs.fourthwall.com/open-api/-beta

Provides examples of JSON payloads for API requests and responses. The request sample demonstrates how to set product availability, while the response sample illustrates the structure of a successful confirmation, including details like IDs, amounts, and item information.

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

---

### Request samples

* Payload

Content type

application/json

Copy

```json
{
  "available": true
}
```
```

--------------------------------

### Product Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON response structure for a product, detailing its ID, name, description, state, access, images, variants, and additional information.

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

--------------------------------

### Get Giveaway Links by Package ID (APIDOC)

Source: https://docs.fourthwall.com/open-api/-docs/open-api-beta

Retrieves all giveaway links for a specific package ID. Requires basic authentication. Includes an example for the packageId parameter.

```APIDOC
/open-api/v1.0/giveaway-links/packages/{packageId}:
  get:
    tags:
      - Giveaway links
    summary: Get giveaway links
    description: Returns all giveaway links for packageId
    externalDocs:
      url: >-
        https://docs.fourthwall.com/open-api/#tag/Giveaway-links/operation/getGiveawayLinksByPackageId
    operationId: getGiveawayLinksByPackageId
    parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        example: 00aa4abd-5778-4199-8161-0b49b2f212e5
    responses:
      '200':
        description: OK
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/com.fourthwall.openapi.model.GiveawayLinksV1
      '400':
        description: Bad Request
        content:
          '*/*':
            schema:
              type: object
    security:
      - basicAuth: []
```

--------------------------------

### Promotions Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON response for promotions, detailing promotion type, ID, title, discount details, status, requirements, and usage limits.

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

--------------------------------

### Get Member Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON structure for retrieving a specific member's details, including their ID, email, nickname, creation date, and subscription information.

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

--------------------------------

### Get Member Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON structure for retrieving a specific member's details, including their ID, email, nickname, creation date, and subscription information.

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

--------------------------------

### API Request and Response Samples

Source: https://docs.fourthwall.com/open-api/index

Provides examples of JSON payloads for API requests and responses. The request sample demonstrates how to set product availability, while the response sample illustrates the structure of a successful confirmation, including details like IDs, amounts, and item information.

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

---

### Request samples

* Payload

Content type

application/json

Copy

```json
{
  "available": true
}
```
```

--------------------------------

### Get Member Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON structure for retrieving a specific member's details, including their ID, email, nickname, creation date, and subscription information.

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

--------------------------------

### Promotions Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON response for promotions, detailing promotion type, ID, title, discount details, status, requirements, and usage limits.

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

--------------------------------

### Product Inventory Response Sample

Source: https://docs.fourthwall.com/open-api/-beta/index

Example JSON response for product inventory, showing a list of variants with their IDs, quantities, and timestamps.

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

--------------------------------

### Get All Giveaway Packages

Source: https://docs.fourthwall.com/open-api/-beta

Retrieves all packages that contain giveaway links. This endpoint is useful for getting an overview of available giveaway packages.

```APIDOC
GET /open-api/v1.0/giveaway-links/packages

Description: Returns all packages with giveaway links.
Authorizations: basicAuth
Responses:
  200 OK: Successful retrieval of packages.
    Content type: application/json
    Example:
    {
      "packageId": "gpg_EdJvIXu3SEiXe_QkPavHSA",
      "giveawayLinks": [
        {
          "status": "string",
          "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
          "link": "<https://fourthwall.com/gifts/gft_EdJvIXu3SEiXe_QkPavHSA>",
          "productId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "createdAt": "2020-08-13T09:05:36.939Z"
        }
      ]
    }
  400 Bad Request: Invalid request parameters.
```

--------------------------------

### Get All Giveaway Packages

Source: https://docs.fourthwall.com/open-api/-beta/index

Retrieves all packages that contain giveaway links. This endpoint is useful for getting an overview of available giveaway packages.

```APIDOC
GET /open-api/v1.0/giveaway-links/packages

Description: Returns all packages with giveaway links.
Authorizations: basicAuth
Responses:
  200 OK: Successful retrieval of packages.
    Content type: application/json
    Example:
    {
      "packageId": "gpg_EdJvIXu3SEiXe_QkPavHSA",
      "giveawayLinks": [
        {
          "status": "string",
          "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
          "link": "<https://fourthwall.com/gifts/gft_EdJvIXu3SEiXe_QkPavHSA>",
          "productId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "createdAt": "2020-08-13T09:05:36.939Z"
        }
      ]
    }
  400 Bad Request: Invalid request parameters.
```

--------------------------------

### Product Inventory Response Sample

Source: https://docs.fourthwall.com/open-api/-beta

Example JSON response for product inventory, showing a list of variants with their IDs, quantities, and timestamps.

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

--------------------------------

### Promotions Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON response for promotions, detailing promotion type, ID, title, discount details, status, requirements, and usage limits.

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

--------------------------------

### Get All Giveaway Packages

Source: https://docs.fourthwall.com/open-api/index

Retrieves all packages that contain giveaway links. This endpoint is useful for getting an overview of available giveaway packages.

```APIDOC
GET /open-api/v1.0/giveaway-links/packages

Description: Returns all packages with giveaway links.
Authorizations: basicAuth
Responses:
  200 OK: Successful retrieval of packages.
    Content type: application/json
    Example:
    {
      "packageId": "gpg_EdJvIXu3SEiXe_QkPavHSA",
      "giveawayLinks": [
        {
          "status": "string",
          "id": "gft_EdJvIXu3SEiXe_QkPavHSA",
          "link": "<https://fourthwall.com/gifts/gft_EdJvIXu3SEiXe_QkPavHSA>",
          "productId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "createdAt": "2020-08-13T09:05:36.939Z"
        }
      ]
    }
  400 Bad Request: Invalid request parameters.
```

--------------------------------

### Get Order by Friendly ID API Endpoint

Source: https://docs.fourthwall.com/open-api/-beta

Retrieves order details using a unique friendly ID. This GET request requires OAuth authorization and accepts the friendlyId as a path parameter. It returns a 200 OK status with order details or a 400 Bad Request.

```APIDOC
GET /open-api/v1.0/order/by-friendly-id/{friendlyId}

Server URL:
https://api.fourthwall.com

Authorizations:
oauth

Path Parameters:
- friendlyId (required, string): The unique identifier for the order. Example: D3XZFWPP

Responses:
- 200 OK: Returns order details in JSON format.
- 400 Bad Request: Indicates an invalid request.

Example Request:
GET https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/D3XZFWPP
Authorization: Bearer YOUR_ACCESS_TOKEN
```

--------------------------------

### Product Inventory Response Sample

Source: https://docs.fourthwall.com/open-api/index

Example JSON response for product inventory, showing a list of variants with their IDs, quantities, and timestamps.

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

--------------------------------

### Giveaway Links API - Create Giveaway Links

Source: https://docs.fourthwall.com/open-api/-beta

Creates a package of giveaway links for a specified product and quantity.

```APIDOC
POST /open-api/v1.0/giveaway-links

Description:
  Creates a new package with a specified number of giveaway links.

Authorizations:
  basicAuth

Request Body Schema (application/json, required):
  productId (string (uuid), required): The unique identifier of the product.
  number (integer (int32), required): The number of giveaway links to create.

Responses:
  200 OK: Giveaway links created successfully.
  400 Bad Request: Invalid input or parameters.

Request Samples:
  Payload (application/json):
    {
      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
      "number": 0
    }
```

--------------------------------

### Get Order by Friendly ID API Endpoint

Source: https://docs.fourthwall.com/open-api/-beta/index

Retrieves order details using a unique friendly ID. This GET request requires OAuth authorization and accepts the friendlyId as a path parameter. It returns a 200 OK status with order details or a 400 Bad Request.

```APIDOC
GET /open-api/v1.0/order/by-friendly-id/{friendlyId}

Server URL:
https://api.fourthwall.com

Authorizations:
oauth

Path Parameters:
- friendlyId (required, string): The unique identifier for the order. Example: D3XZFWPP

Responses:
- 200 OK: Returns order details in JSON format.
- 400 Bad Request: Indicates an invalid request.

Example Request:
GET https://api.fourthwall.com/open-api/v1.0/order/by-friendly-id/D3XZFWPP
Authorization: Bearer YOUR_ACCESS_TOKEN
```
Tokens:
Raw