API reference

Products

A product is one SKU: your reference, a name and the photos you hold for it. Everything else in the API hangs off a product — renders are generated from it, exports are grouped by it.

Endpoints

POST/v1/products
GET/v1/products
GET/v1/products/{product_id}
PATCH/v1/products/{product_id}
DELETE/v1/products/{product_id}
POST/v1/products/{product_id}/images
DELETE/v1/products/{product_id}/images/{image_id}

The Product object

Attributes

idstring
Crockford-base32 ULID (26 chars).
namestring
referencestring
descriptionstring, nullable
sexenum, nullable
- male
- female
- other
- kid
imagesarray of objects
Show child attributesHide child attributes
- idstring
  Crockford-base32 ULID (26 chars).
- orientationstring
- originenum
  - user
  - beautifier
  - other
created_attimestamp
When the product was created. For products that predate timestamp tracking (2026-09), the date of its first image.
updated_attimestamp
Last change to the product's own fields (name, reference, description, sex). Attaching or removing images does not bump it; use the export delta for asset changes.

The Product object

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "description": "A short description.",
  "sex": "male",
  "images": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front",
      "origin": "user"
    }
  ],
  "created_at": "2026-04-27T14:32:00Z",
  "updated_at": "2026-04-27T14:32:00Z"
}

Create a product

POST/v1/products

The single-product path. Two steps:

Upload each image with POST /v1/images (multipart). You get back an image_id.
Call this endpoint with the image_ids and the orientation each one represents.

Creating more than a handful? Use POST /v1/imports: one JSON line per product with the URLs of its photos, fetched by us, validated whole, processed as a job, retry-safe by reference. This endpoint stays supported for one-at-a-time creation (a back-office form, a manual fix) — it is simply the wrong shape for a catalogue.

Image references must belong to the calling organization and not be soft-deleted. The same image_id can be referenced by multiple Products if you want to reuse a shot.

Parameters

namestringrequired
referencestringrequired
Your own product code (e.g. the SKU in your PIM). Required and unique within your organization for products created through the API; surrounding whitespace is trimmed.
descriptionstringoptional
sexenumoptional
- male
- female
- other
- kid
imagesarray of objectsrequired
References to images previously uploaded via POST /v1/images. Each entry pairs an image_id with the orientation it represents on this Product.
Show child attributesHide child attributes
- image_idstringrequired
  ID returned from POST /v1/images.
- orientationenumrequired
  Possible enum values (11)
  - front
  - back
  - left
  - right
  - top
  - bottom
  - three-quarter-left
  - three-quarter-right
  - detail
  - unlabeled
  - side

Returns

Returns a Product object with status 201.

Errors

400
Invalid request
401
Unauthorized
404
One or more image_ids not found
409
A product with this reference already exists in the organization
500
Server error

POST/v1/products

curl https://api.veeton.com/v1/products \
  -H "Authorization: Bearer $VEETON_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "images": [
    {
      "image_id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front"
    }
  ]
}'
import requests

response = requests.post(
    "https://api.veeton.com/v1/products",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
    json={
          "name": "Crewneck Tee — Sage",
          "reference": "TEE-SAGE-001",
          "images": [
            {
              "image_id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
              "orientation": "front"
            }
          ]
        },
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/products", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${VEETON_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Crewneck Tee — Sage",
    reference: "TEE-SAGE-001",
    images: [
      {
        image_id: "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
        orientation: "front"
      }
    ]
  }),
})

const data = await response.json()

Response · 201

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "description": "A short description.",
  "sex": "male",
  "images": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front",
      "origin": "user"
    }
  ],
  "created_at": "2026-04-27T14:32:00Z",
  "updated_at": "2026-04-27T14:32:00Z"
}

List products

GET/v1/products

Cursor-paginated list. Soft-deleted Products are excluded.

Parameters

limitinteger· queryoptional
Default: 25
cursorstring· queryoptional
qstring· queryoptional
Free-text search over name and reference.

Returns

Returns a ProductList object with status 200.

Errors

400
Invalid request
500
Server error

GET/v1/products

curl https://api.veeton.com/v1/products \
  -H "Authorization: Bearer $VEETON_KEY"
import requests

response = requests.get(
    "https://api.veeton.com/v1/products",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/products", {
  headers: { Authorization: `Bearer ${VEETON_KEY}` },
})

const data = await response.json()

Response · 200

{
  "data": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "name": "Crewneck Tee — Sage",
      "reference": "TEE-SAGE-001",
      "description": "A short description.",
      "sex": "male",
      "images": [
        {
          "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
          "orientation": "front",
          "origin": "user"
        }
      ],
      "created_at": "2026-04-27T14:32:00Z",
      "updated_at": "2026-04-27T14:32:00Z"
    }
  ],
  "next_cursor": "eyJpZCI6InByb2RfMDFIWCJ9",
  "has_more": true
}

Retrieve a product

GET/v1/products/{product_id}

Parameters

product_idstringrequired
Crockford-base32 ULID (26 chars).

Returns

Returns a Product object with status 200.

Errors

404
Not found
500
Server error

GET/v1/products/{product_id}

curl https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1 \
  -H "Authorization: Bearer $VEETON_KEY"
import requests

response = requests.get(
    "https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1", {
  headers: { Authorization: `Bearer ${VEETON_KEY}` },
})

const data = await response.json()

Response · 200

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "description": "A short description.",
  "sex": "male",
  "images": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front",
      "origin": "user"
    }
  ],
  "created_at": "2026-04-27T14:32:00Z",
  "updated_at": "2026-04-27T14:32:00Z"
}

Update a product

PATCH/v1/products/{product_id}

JSON Merge Patch semantics. Omitted fields are unchanged; explicit null clears a nullable field. To attach more images, use POST /v1/products/{product_id}/images with image_ids returned from POST /v1/images.

Parameters

product_idstringrequired
Crockford-base32 ULID (26 chars).

Body · application/merge-patch+json

namestringoptional
referencestringoptional
descriptionstring, nullableoptional
sexenum, nullableoptional
- male
- female
- other
- kid

Returns

Returns a Product object with status 200.

Errors

404
Not found
409
Another product in the organization already uses the new reference
500
Server error

PATCH/v1/products/{product_id}

curl -X PATCH \
  https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1 \
  -H "Authorization: Bearer $VEETON_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "description": "A short description.",
  "sex": "male"
}'
import json
import requests

response = requests.patch(
    "https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1",
    headers={"Authorization": f"Bearer {VEETON_KEY}", "Content-Type": "application/merge-patch+json"},
    data=json.dumps({
          "name": "Crewneck Tee — Sage",
          "reference": "TEE-SAGE-001",
          "description": "A short description.",
          "sex": "male"
        }),
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${VEETON_KEY}`,
    "Content-Type": "application/merge-patch+json",
  },
  body: JSON.stringify({
    name: "Crewneck Tee — Sage",
    reference: "TEE-SAGE-001",
    description: "A short description.",
    sex: "male"
  }),
})

const data = await response.json()

Response · 200

{
  "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
  "name": "Crewneck Tee — Sage",
  "reference": "TEE-SAGE-001",
  "description": "A short description.",
  "sex": "male",
  "images": [
    {
      "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front",
      "origin": "user"
    }
  ],
  "created_at": "2026-04-27T14:32:00Z",
  "updated_at": "2026-04-27T14:32:00Z"
}

Delete a product

DELETE/v1/products/{product_id}

Parameters

product_idstringrequired
Crockford-base32 ULID (26 chars).

Returns

An empty response with status 204.

Errors

404
Not found
500
Server error

DELETE/v1/products/{product_id}

curl -X DELETE \
  https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1 \
  -H "Authorization: Bearer $VEETON_KEY"
import requests

response = requests.delete(
    "https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
)

response.raise_for_status()
const response = await fetch("https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${VEETON_KEY}` },
})

if (!response.ok) throw new Error(response.statusText)

Attach images to a product

POST/v1/products/{product_id}/images

Reference image_ids returned from POST /v1/images. Each entry pairs an image_id with the orientation it represents on this Product.

Parameters

product_idstringrequired
Crockford-base32 ULID (26 chars).

Body · application/json

imagesarray of objectsrequired
Show child attributesHide child attributes
- image_idstringrequired
  ID returned from POST /v1/images.
- orientationenumrequired
  Possible enum values (11)
  - front
  - back
  - left
  - right
  - top
  - bottom
  - three-quarter-left
  - three-quarter-right
  - detail
  - unlabeled
  - side

Returns

Returns array of objects with status 201.

Errors

404
Product or image_id not found
500
Server error

POST/v1/products/{product_id}/images

curl https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images \
  -H "Authorization: Bearer $VEETON_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "images": [
    {
      "image_id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
      "orientation": "front"
    }
  ]
}'
import requests

response = requests.post(
    "https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
    json={
          "images": [
            {
              "image_id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
              "orientation": "front"
            }
          ]
        },
)

print(response.json())
const response = await fetch("https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${VEETON_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    images: [
      {
        image_id: "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
        orientation: "front"
      }
    ]
  }),
})

const data = await response.json()

Response · 201

[
  {
    "id": "01HX5K2MZ7A3Q4FBNDC0EVDXY1",
    "orientation": "front",
    "origin": "user"
  }
]

Remove an image from a product

DELETE/v1/products/{product_id}/images/{image_id}

Removes the link between this Product and this Image. The image asset itself is not immediately destroyed — images that are no longer associated with any Product or Task are cleaned up automatically after a while, so you do not need to manage their lifecycle.

Returns 422 with cannot_drop_last_image when the Product would be left with zero images. Delete the Product instead in that case.

Parameters

product_idstringrequired
Crockford-base32 ULID (26 chars).
image_idstringrequired
Crockford-base32 ULID (26 chars).

Returns

An empty response with status 204.

Errors

404
Product or image-on-this-product not found
422
Cannot drop the last image

DELETE/v1/products/{product_id}/images/{image_id}

curl -X DELETE \
  https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images/01HX5K2MZ7A3Q4FBNDC0EVDXY1 \
  -H "Authorization: Bearer $VEETON_KEY"
import requests

response = requests.delete(
    "https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images/01HX5K2MZ7A3Q4FBNDC0EVDXY1",
    headers={"Authorization": f"Bearer {VEETON_KEY}"},
)

response.raise_for_status()
const response = await fetch("https://api.veeton.com/v1/products/01HX5K2MZ7A3Q4FBNDC0EVDXY1/images/01HX5K2MZ7A3Q4FBNDC0EVDXY1", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${VEETON_KEY}` },
})

if (!response.ok) throw new Error(response.statusText)