Skip to main content
POST
/
channel-api
/
v1.0
/
previews
Generate preview images for a product (sync)
curl --request POST \
  --url https://api.fourthwall.com/channel-api/v1.0/previews \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "<string>",
  "regions": [
    {
      "region": "<string>",
      "imageId": "<string>",
      "placementId": "<string>",
      "fillAllPlacements": true
    }
  ],
  "colors": [
    "<string>"
  ],
  "sizes": [
    "<string>"
  ]
}
'
import requests

url = "https://api.fourthwall.com/channel-api/v1.0/previews"

payload = {
"productId": "<string>",
"regions": [
{
"region": "<string>",
"imageId": "<string>",
"placementId": "<string>",
"fillAllPlacements": True
}
],
"colors": ["<string>"],
"sizes": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
productId: '<string>',
regions: [
{
region: '<string>',
imageId: '<string>',
placementId: '<string>',
fillAllPlacements: true
}
],
colors: ['<string>'],
sizes: ['<string>']
})
};

fetch('https://api.fourthwall.com/channel-api/v1.0/previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fourthwall.com/channel-api/v1.0/previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'productId' => '<string>',
'regions' => [
[
'region' => '<string>',
'imageId' => '<string>',
'placementId' => '<string>',
'fillAllPlacements' => true
]
],
'colors' => [
'<string>'
],
'sizes' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.fourthwall.com/channel-api/v1.0/previews"

payload := strings.NewReader("{\n \"productId\": \"<string>\",\n \"regions\": [\n {\n \"region\": \"<string>\",\n \"imageId\": \"<string>\",\n \"placementId\": \"<string>\",\n \"fillAllPlacements\": true\n }\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"sizes\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.fourthwall.com/channel-api/v1.0/previews")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"<string>\",\n \"regions\": [\n {\n \"region\": \"<string>\",\n \"imageId\": \"<string>\",\n \"placementId\": \"<string>\",\n \"fillAllPlacements\": true\n }\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"sizes\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.fourthwall.com/channel-api/v1.0/previews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"<string>\",\n \"regions\": [\n {\n \"region\": \"<string>\",\n \"imageId\": \"<string>\",\n \"placementId\": \"<string>\",\n \"fillAllPlacements\": true\n }\n ],\n \"colors\": [\n \"<string>\"\n ],\n \"sizes\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "pipelineId": "<string>",
  "images": [
    {
      "url": "<string>",
      "width": 123,
      "height": 123,
      "style": "<string>",
      "color": "<string>",
      "size": "<string>",
      "region": "<string>"
    }
  ],
  "customizationId": "<string>"
}
This endpoint is in beta and subject to change.

Body

application/json
productId
string
required
regions
Preview Region Input X Request · object[]
required
colors
string[]
sizes
string[]

Response

201 - application/json

Created

pipelineId
string
required
images
Preview Image X Response · object[]
required
customizationId
string