Merchandise Process

post

https://api.spyne.ai/api/pv1/merchandise/process

Submits vehicle images or video for asynchronous processing into catalog images, a 360 spin, a feature video, or media kit assets.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
View Documentation

Provide at least one vehicle identifier. Any one of the following is sufficient:

vin: the vehicle's 17-character alphanumeric VIN
stockNumber: the dealer's internal inventory identifier
registrationNumber: the vehicle's official registration number

Processing is asynchronous. A 202 response confirms only that the request was accepted and returns a dealerVinID. Retrieve the output later with the Retrieve Media endpoint, or receive it by webhook.

Image URLs are validated before processing begins. A maximum of 200 URLs is accepted per request, each must use the http or https scheme, and each must return a 2xx or 3xx status when fetched. Duplicate URLs are collapsed.

Body Params

vin

string

VIN is the unique 17-character alphanumeric identifier of a vehicle. If the VIN is not available, you can use the Stock Number or Registration Number as alternate identifiers. At least one of the three is required.

stockNumber

string

A dealer's internal identifier for inventory tracking

registrationNumber

string

The vehicle's official registration number used for identification

dealerId

string

Deprecated and ignored. This field is accepted for backward compatibility but has no effect on processing. The team the vehicle is processed under is always taken from the authenticated API credential, not from this value.

media

object

required

The "media" parameter specifies the types of media to be processed. Each parameter is a boolean (true or false), indicating whether the corresponding media type should be processed. If any value is not provided, it defaults to null, and the corresponding media type will not be processed.

mediaInput

object

required

The "mediaInput" parameter contains an array of URLs for either images, videos, or both, which are to be processed.

processingDetails

object

required

The "processingDetails" parameter specifies additional configurations and customizations for processing the media. This includes details like logos, templates, and processing-specific settings

Responses

View Documentation

202Processing accepted. This does not carry processed output; retrieve it later with Retrieve Media or receive it by webhook.

400No vehicle identifier supplied; an image URL was malformed, unreachable, or over the 200-URL limit; a custom media kit was sent while a live campaign exists; or any 4xx relayed from the processing service.

401Missing or invalid credential. Emitted by the auth layer, and shaped differently to the other errors.

403Returned by the edge layer for a permission failure. The application itself collapses upstream 4xx into 400.

429Returned by the edge layer when a rate limit is exceeded. The application itself collapses upstream 4xx into 400.

500Processing service unreachable, or the campaign check failed.

503Returned by the edge layer when the service is unavailable.