Skip to content
Pixii

Create listing

Generate a complete product listing from an ASIN. Main image plus full gallery, in one job.

Generate a complete product listing from an ASIN. Pixii analyzes the product and produces a full set of visuals, main image plus gallery, designed for your target platform and marketplace.

This endpoint costs 70 credits per listing. Visuals that fail to generate are refunded individually.

This is an async endpoint. It returns a job_id immediately. Use the Jobs API to poll for the result.

Endpoint

POST /v2/api/create_listing

Request body

Parameter Type Required Description
brand_id number Optional The brand to work in. Take it from Brands. Defaults to your default brand.
product object Required The product to design for. See product below.
listing_type enum Required Type of listing. See listing types below.
effort enum Optional How much creative freedom the generator gets. See effort below. Defaults to Creative.
user_prompt string Optional Creative direction in your own words, up to 1000 characters. For example a scene, a mood, an audience or a claim to feature.
include_creative_strategy boolean Optional Include the creative strategy in the completed job output. Defaults to false. No extra credits.

Product

The product object identifies the product to design for. Pass an ASIN with its marketplace, or the product_id of a product Pixii already knows (every completed job returns one in its output). The asin field also takes a product page URL: an Amazon product page of any marketplace (shortlinks included), which is read as its ASIN and marketplace, a Walmart product page (walmart.com or walmart.ca), which is read as its item ID and marketplace, or a Shopify product page. A Walmart item ID also goes in asin; its country_code is US (walmart.com, the default) or CA (walmart.ca), and any other marketplace fails with VALIDATION_ERROR. create_anything, scale and download_visuals accept these same forms. A product_id that is not in your account fails the job with PRODUCT_NOT_FOUND.

Parameter Type Required Description
asin string Optional Amazon Standard Identification Number, Walmart item ID, or an Amazon, Walmart or Shopify product page URL. country_code is required with a bare ASIN; a Walmart item ID takes US (default) or CA.
country_code string Optional Marketplace of the ASIN. See supported marketplaces below.
product_id string Optional Pixii product ID. Use instead of asin and country_code.
main_image string Optional Your own main image for the product, as a public image URL or base64 bytes (PNG, JPEG or WebP, up to 10 MB). Only with asin.
other_images string[] Optional Up to 4 additional product images, URLs or base64 bytes. Requires main_image.

Listing types

The listing_type field accepts one of the following values:

Amazon Listing Full Amazon product listing, main image plus gallery
Shopify Listing Shopify product page visuals
TikTok Shop Listing TikTok Shop optimized visuals
Walmart Listing Walmart product page visuals
Amazon Mobile Listing Optimized for Amazon mobile display
Amazon Main Images Amazon main images only

Effort

The optional effort field controls how far the generator may stray from your product photos:

Creative The generator may compose new angles and scenes for your product (default)
Reliable Every visual stays on an angle your product photos already show

Supported marketplaces

The country_code field accepts any of the following ISO country codes:

AE   AU   BE   BR   CA   CN   DE   EG   ES   FR   GB   IE   IN   IT   JP   MX   NL   PL   SA   SE   SG   TR   UK   US   ZA

Creative strategy

Set include_creative_strategy to true and the completed job’s output carries a creative_strategy object alongside the visuals. It is the same analysis the Creative strategy API returns, at no extra cost, because this job already produced it.

Response

A successful request returns 200 with a job id. The job runs in the background, so use the Jobs API to retrieve the result.

FieldTypeDescription
job_idstringUnique identifier for the job. Use this to poll for results.
job_typestringAlways create_listing for this endpoint.
brand_idnumberThe brand the job runs in.
session_idstringThe Pixii session that will hold the visuals, the same value the job output returns.
statusstringInitial status. Always pending on submission.
created_atstringISO 8601 timestamp of when the job was created.
credit_costnumberCredits charged for this job.
remaining_creditsnumberCredits remaining on your account after this request was accepted.

Submitting the same product again while a job for it is still running returns the running job instead of starting a second one.

Job output

When the job completes, output contains:

FieldTypeDescription
productobjectproduct_id, asin and country_code of the product.
session_idstringThe Pixii session that holds these visuals.
listing_typestringThe listing type that was generated.
campaign_adsarrayOne entry per generated visual, the main image first. See campaign ads.
creative_strategyobjectOnly when include_creative_strategy is true.

Errors

CodeHTTPDescription
VALIDATION_ERROR400One or more request parameters are invalid.
INVALID_IMAGE400An image is not a public URL or valid base64.
NO_ACTIVE_BRAND400No active brand found for your organization.
BRAND_NOT_FOUND404No active brand with this brand_id in your organization.
UNAUTHORIZED401Missing or invalid API key.
INSUFFICIENT_CREDITS402Not enough credits to process this request.
RATE_LIMIT_MINUTE_EXCEEDED429Too many requests in the current minute window.
RATE_LIMIT_DAY_EXCEEDED429Daily request limit reached.
INTERNAL_ERROR500An unexpected error occurred.
SERVICE_UNAVAILABLE503Service is temporarily unavailable.

See the errors reference for the full list and how to handle each one.