Skip to navigation

List colorways

List colorways visible to the public API key. Variants belonging to archived products are excluded by default, including when filtering by productId. Pass includeArchived=true to include them.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includeArchivedbooleanOptionalDefaults to false
Include variants belonging to archived products.
pageintegerOptional
perPageintegerOptional
productIdstringOptionalformat: "uuid"

Response

Successful operation
namestringOptional
productIdstringOptionalformat: "uuid"
referencestringOptional
shopifyProductIdstringOptional
colorIdstringOptionalformat: "uuid"
mainComponentIdstringOptionalformat: "uuid"
positionintegerOptional
hsCodestringOptional
hsCodeExplanationstringOptional
dppNamestringOptional
dppReferencestringOptional
dppRedirectUrlstringOptionalformat: "uri"
dppStatusstringOptional
dropIdstringOptionalformat: "uuid"
developmentStageIdstringOptionalformat: "uuid"
archivedbooleanOptional
secondaryColorslist of stringsOptional
dppManufacturingDatamap from strings to anyOptional
idintegerOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
colormap from strings to anyOptional
developmentStagemap from strings to anyOptional
variantPhotoslist of objectsOptional

Colorway photos. Use /variant_photos to upload, replace, or delete them.

variantValueslist of maps from strings to anyOptional
variantComponentslist of maps from strings to anyOptional

Errors

401
Unauthorized Error