Seamdex
Start Now
Documentation

Seamdex API

Everything the app does with products, purchase orders and passports, from your own systems.

Quick start

The typical flow mirrors the app: import the purchase order rows your ERP exports, read back what still blocks publishing, fill the gaps, publish, then pull the passports and their QR codes into your labelling system. The same operations are available to AI assistants through the MCP server.

  1. Import a purchase order: POST /api/v1/purchase-orders/import
  2. Check what still blocks publishing: GET /api/v1/purchase-orders/{id}
  3. Fill the gaps on a product: PATCH /api/v1/products/{id}
  4. Publish it: POST /api/v1/products/{id}/publish
  5. List the passports: GET /api/v1/passports
  6. Fetch a QR code: GET /api/v1/passports/{dppId}/qr
curl -X GET "https://www.seamdex.com/api/v1/me" \
  -H "Authorization: Bearer sdx_..."

Authentication

API access is an Enterprise feature; once enabled for your organization, an owner creates keys in Settings under API Keys. A key belongs to the organization (not to the member who created it), carries the scopes chosen at creation and can be revoked at any time. The key is shown once.

Send it on every request as Authorization: Bearer sdx_.... Keys are server-to-server credentials: never ship one in a browser or mobile app.

ScopeGrants
product:readProducts: Read
product:createProducts: Create
product:updateProducts: Update
product:deleteProducts: Delete
product:publishProducts: Publish
purchaseOrder:readPurchase Orders: Read
purchaseOrder:createPurchase Orders: Create
purchaseOrder:deletePurchase Orders: Delete

Base URL and versioning

https://www.seamdex.com/api/v1. Requests only work on the Seamdex platform host, not on custom passport domains. Changes within v1 are additive (new fields, new endpoints); a breaking change would ship as v2 alongside v1. A machine-readable description is served at /api/v1/openapi.json.

Errors

Every error is { "error": { "code", "message", "details" } }. details, when present, is an array of { "field", "msg" } objects (import rows add row, publish blockers add tab). Every response carries an X-Request-Id header; quote it when contacting support.

CodeStatusWhen
unauthorized401Missing, malformed or unknown API key
key_revoked401The key was revoked in Settings
key_expired401The key passed its expiry date
api_access_disabled403API access is not enabled for the organization
subscription_required403The organization has no active subscription
insufficient_scope403The key lacks the scope the endpoint requires
not_found404No such resource in this organization
invalid_json400The request body is not valid JSON
payload_too_large413The request body exceeds the endpoint cap
validation_failed422A field failed validation
invalid_query422A query parameter failed validation
invalid_cursor422The cursor is malformed
range_too_large422The EPR period holds more products than one report allows
no_styles422An import found no importable styles in the rows
too_many_styles422An import holds more styles than one call allows
image_fetch_failed422The image URL could not be fetched or is not an image
invalid_rows422Import rows failed validation; details carry the row index
style_spans_pos422One style appears under two PO numbers in one import
publish_blocked422The publish gate found missing data; details list it
publish_locked409Another publish holds the lock; retry shortly
product_published409Deleting a live product needs ?force=true
po_has_published_products409A PO with live passports cannot be deleted
conflict409A conflicting record already exists
rate_limited429Budget exhausted; honour Retry-After
internal_error500Unexpected failure; quote the requestId to support

Rate limits

  • 600 requests per minute per key, reported on every response in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds).
  • 2000 requests per minute per organization across all its keys.
  • Heavier operations have their own per-organization budgets per minute: publish 60, bulk publish 5, import 10, image attach 30.
  • A 429 carries Retry-After in seconds. Back off and retry; do not create more keys to raise the budget.

Pagination and sync

Lists return { "data": [...], "meta": { "hasMore", "nextCursor", "total" } }. Pass meta.nextCursor back as cursor to get the next page; cursors are opaque. Products and purchase orders default to 50 per page (max 200). Passports page over products: limit counts products and every passport of those products is returned.

Lists are in creation order, newest first, so a document updated while you page is never skipped. For incremental sync record the time you started, walk every page with updatedSince set to the previous start time (publishedSince for passports), then store the new start time. Anything changed during the walk is picked up next time.

Files and images

Product bodies only accept file URLs that already live in Seamdex storage for your organization. External image links are not written to products directly: send them as imageUrl on import rows, or attach them with POST /products/{id}/images, and Seamdex fetches and re-hosts the image (public http(s) hosts only, up to 8 MB, image types only).

Publish requirements

Publishing freezes the record and mints one passport page per size that has a GTIN. GET /products/{id}/readiness reports exactly what still blocks it. A product needs:

  • a style number, a style name and a DPP number (imports derive it; products created directly must set basics.dppNumber),
  • an Economic Operator with an EU or approved country,
  • a garment type,
  • fibre percentages that sum to 100 per component,
  • the three REACH compliance confirmations,
  • at least one size with a quantity and a unique barcode.

Imports accept up to 500 styles per request; the row format is described in the import guide. A published style counts once toward your subscription, whatever its sizes and colours, exactly as in the app.

Endpoints

Getting Started

2 Endpoints

Discover the API and check your key.

GET/api/v1/openapi.jsonNo authentication

OpenAPI 3.1 document

Machine-readable description of this API. No authentication.

Example request
curl -X GET "https://www.seamdex.com/api/v1/openapi.json"
Response 200
{
  "openapi": "3.1.0",
  "info": {
    "title": "Seamdex API"
  }
}
GET/api/v1/meAny valid key

Identify the calling key

Returns the organization, the key metadata and the current rate-limit budget. Use it to test a new key.

Example request
curl -X GET "https://www.seamdex.com/api/v1/me" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "organization": {
      "id": "org_abc",
      "name": "Acme Apparel",
      "slug": "acme",
      "defaultMode": "full",
      "passportOrigin": "https://passport.acme.com"
    },
    "key": {
      "id": "66d0a1b2c3d4e5f6a7b8c9d0",
      "name": "ERP sync",
      "scopes": [
        "product:read",
        "purchaseOrder:create"
      ],
      "createdAt": "2026-09-01T10:00:00.000Z",
      "lastUsedAt": null,
      "expiresAt": null
    },
    "rateLimit": {
      "limit": 600,
      "remaining": 599,
      "reset": 1757325600
    }
  }
}

Products

10 Endpoints

Create, edit, publish and delete products.

GET/api/v1/productsScope product:read

List products

Creation order, newest first. Stable cursors: a product updated while you page is never skipped. Use updatedSince for incremental sync.

ParameterInTypeDescription
qquerystringSearch style number or style name
statusquerydraft | published | archived
purchaseOrderIdquerystring
seasonquerystringSeason code, exact match (SS27)
updatedSincequerystring (date-time)Only products updated at or after this ISO 8601 timestamp (incremental sync)
cursorquerystringOpaque cursor from the previous page meta.nextCursor
limitqueryintegerPage size (default 50, max 200)
Example request
curl -X GET "https://www.seamdex.com/api/v1/products?updatedSince=2026-09-01T00%3A00%3A00Z&limit=50" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "id": "66d0a1b2c3d4e5f6a7b8c9d0",
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "color": "Navy",
      "season": "SS27",
      "ean": "5712952970021",
      "status": "draft",
      "mode": "full",
      "pendingChanges": false,
      "purchaseOrderId": "66d0a1b2c3d4e5f6a7b8c9e1",
      "variantCount": 4,
      "totalQuantity": 480,
      "passportCount": 0,
      "certComplete": true,
      "certState": "noData",
      "publishVersion": 0,
      "publishedAt": null,
      "createdAt": "2026-09-08T09:00:00.000Z",
      "updatedAt": "2026-09-08T09:05:12.000Z"
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null,
    "total": 1
  }
}
POST/api/v1/productsScope product:create

Create a draft product

Any editable section may be sent; an empty body creates a blank draft with the organization defaults. Products created here need basics.dppNumber set before they can publish. File URLs must be Seamdex storage URLs: attach images through POST /products/{id}/images.

Example request
curl -X POST "https://www.seamdex.com/api/v1/products" \
  -H "Authorization: Bearer sdx_..." \
  -H "Content-Type: application/json" \
  -d '{"basics":{"styleNumber":"SR226-602","garmentName":"Wool Jacket","color":"Navy","ean":"5712952970021","dppNumber":"5712952970021-SR226-602","hsCode":"6203","countryOfOrigin":"Portugal"},"composition":{"garmentType":"woven"},"variants":[{"size":"S","color":"Navy","ean":"5712952970014","quantity":120},{"size":"M","color":"Navy","ean":"5712952970021","quantity":240}]}'
Request body
{
  "basics": {
    "styleNumber": "SR226-602",
    "garmentName": "Wool Jacket",
    "color": "Navy",
    "ean": "5712952970021",
    "dppNumber": "5712952970021-SR226-602",
    "hsCode": "6203",
    "countryOfOrigin": "Portugal"
  },
  "composition": {
    "garmentType": "woven"
  },
  "variants": [
    {
      "size": "S",
      "color": "Navy",
      "ean": "5712952970014",
      "quantity": 120
    },
    {
      "size": "M",
      "color": "Navy",
      "ean": "5712952970021",
      "quantity": 240
    }
  ]
}
Response 201
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "status": "draft",
    "mode": "full",
    "basics": {
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "color": "Navy",
      "ean": "5712952970021",
      "dppNumber": "5712952970021-SR226-602",
      "hsCode": "6203",
      "countryOfOrigin": "Portugal"
    },
    "composition": {
      "garmentType": "woven"
    },
    "variants": [
      {
        "size": "S",
        "color": "Navy",
        "ean": "5712952970014",
        "quantity": 120
      },
      {
        "size": "M",
        "color": "Navy",
        "ean": "5712952970021",
        "quantity": 240
      }
    ],
    "passports": []
  }
}
GET/api/v1/products/{id}Scope product:read

Get a product

The full working record including the server-computed figures and its passports. Add include=snapshot for the frozen published snapshot.

ParameterInTypeDescription
id requiredpathstringThe resource id
includequerysnapshotAdd the frozen publishedSnapshot
Example request
curl -X GET "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "status": "published",
    "mode": "full",
    "basics": {
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "color": "Navy",
      "ean": "5712952970021",
      "dppNumber": "5712952970021-SR226-602",
      "hsCode": "6203",
      "countryOfOrigin": "Portugal"
    },
    "composition": {
      "garmentType": "woven"
    },
    "variants": [
      {
        "size": "S",
        "color": "Navy",
        "ean": "5712952970014",
        "quantity": 120
      },
      {
        "size": "M",
        "color": "Navy",
        "ean": "5712952970021",
        "quantity": 240
      }
    ],
    "passports": [
      {
        "dppId": "Xk7Pq2mN9vRt",
        "gtin": "5712952970021",
        "gtin14": "05712952970021",
        "size": "M",
        "color": "Navy",
        "scope": "size",
        "retired": false,
        "path": "/01/05712952970021/21/Xk7Pq2mN9vRt",
        "url": "https://www.dpp.seamdex.com/01/05712952970021/21/Xk7Pq2mN9vRt",
        "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
        "styleNumber": "SR226-602",
        "garmentName": "Wool Jacket",
        "publishedAt": "2026-09-08T09:12:44.000Z",
        "publishVersion": 1
      }
    ]
  }
}
PATCH/api/v1/products/{id}Scope product:update

Update product sections

Section-level replace: every section present in the body replaces that section wholesale (send the full section, exactly like the editor). Editing a published product records pending changes; the public passport keeps the frozen snapshot until you publish again.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X PATCH "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..." \
  -H "Content-Type: application/json" \
  -d '{"identity":{"eoName":"Acme Apparel ApS","eoCountry":"Denmark"}}'
Request body
{
  "identity": {
    "eoName": "Acme Apparel ApS",
    "eoCountry": "Denmark"
  }
}
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "status": "draft"
  },
  "meta": {
    "sectionsChanged": [
      "identity"
    ],
    "wasPublished": false,
    "pendingChanges": false
  }
}
DELETE/api/v1/products/{id}Scope product:delete

Delete a product

A published product is refused with 409 product_published unless force=true is passed: its public passports stop resolving.

ParameterInTypeDescription
id requiredpathstringThe resource id
forcequerybooleanRequired to delete a published product
Example request
curl -X DELETE "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "deleted": true,
    "passportsRemoved": 0
  }
}
GET/api/v1/products/{id}/readinessScope product:read

Publish readiness

Runs the real publish gate and the completeness remarks without publishing. errors block publishing; warnings do not.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X GET "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0/readiness" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "status": "draft",
    "ready": false,
    "publishable": false,
    "notStarted": false,
    "errors": [
      {
        "field": "identity.eoName",
        "tab": "identity",
        "msg": "Economic Operator name is required"
      }
    ],
    "warnings": []
  }
}
GET/api/v1/products/{id}/revisionsScope product:read

Publish history

Every published version of the product, newest first, with who published it and which sections changed. The last 50 versions are kept.

ParameterInTypeDescription
id requiredpathstringThe resource id
limitqueryintegerPage size (default 50, max 50)
Example request
curl -X GET "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0/revisions?limit=50" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
      "publishVersion": 2,
      "publishedAt": "2026-03-12T09:30:00.000Z",
      "live": true,
      "actor": {
        "type": "brand",
        "userId": "u_1",
        "email": "anna@brand.example",
        "name": "Anna"
      },
      "changedPaths": [
        "composition.wovenLayers",
        "care.careSymbols"
      ],
      "changeCount": 3
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null,
    "total": 1
  }
}
GET/api/v1/products/{id}/revisions/{version}Scope product:read

One published version

The frozen snapshot of one publish plus the field-level changes against the version before it.

ParameterInTypeDescription
id requiredpathstringThe resource id
version requiredpathintegerThe publish version number
Example request
curl -X GET "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0/revisions/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
    "publishVersion": 2,
    "publishedAt": "2026-03-12T09:30:00.000Z",
    "live": true,
    "actor": {
      "type": "brand",
      "userId": "u_1",
      "email": "anna@brand.example",
      "name": "Anna"
    },
    "changedPaths": [
      "care.careSymbols"
    ],
    "changeCount": 1,
    "previousVersion": 1,
    "changes": [
      {
        "path": "care.careSymbols",
        "label": "Wash & Care / Care symbols",
        "kind": "changed",
        "from": "WASH-30, NO-BLEACH",
        "to": "WASH-30"
      }
    ],
    "snapshot": {}
  }
}
POST/api/v1/products/{id}/publishScope product:publish

Publish a product

Freezes the snapshot and mints (or reuses) one passport per size with a GTIN. Re-publishing pushes pending changes live and keeps every passport id stable. The style counts once toward this subscription year's style passports, whatever its sizes and colours, exactly as in the app.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X POST "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0/publish" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9d0",
    "status": "published",
    "publishVersion": 1,
    "publishedAt": "2026-09-08T09:12:44.000Z",
    "liveCount": 1,
    "passports": [
      {
        "dppId": "Xk7Pq2mN9vRt",
        "gtin": "5712952970021",
        "gtin14": "05712952970021",
        "size": "M",
        "color": "Navy",
        "scope": "size",
        "retired": false,
        "path": "/01/05712952970021/21/Xk7Pq2mN9vRt",
        "url": "https://www.dpp.seamdex.com/01/05712952970021/21/Xk7Pq2mN9vRt",
        "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
        "styleNumber": "SR226-602",
        "garmentName": "Wool Jacket",
        "publishedAt": "2026-09-08T09:12:44.000Z",
        "publishVersion": 1
      }
    ]
  }
}
POST/api/v1/products/{id}/imagesScope product:update

Attach an image by URL

Fetches a public image URL server side and re-hosts it in Seamdex storage (max 8 MB, image content types only). Without colorway it becomes a product image; with colorway it is added to that colorway.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X POST "https://www.seamdex.com/api/v1/products/66d0a1b2c3d4e5f6a7b8c9d0/images" \
  -H "Authorization: Bearer sdx_..." \
  -H "Content-Type: application/json" \
  -d '{"url":"https://cdn.example.com/sr226-602-navy.jpg","colorway":"Navy"}'
Request body
{
  "url": "https://cdn.example.com/sr226-602-navy.jpg",
  "colorway": "Navy"
}
Response 201
{
  "data": {
    "name": "sr226-602-navy.jpg",
    "url": "https://xyz.public.blob.vercel-storage.com/po-images/org_abc/sr226-602-navy.jpg",
    "sourceUrl": "https://cdn.example.com/sr226-602-navy.jpg",
    "section": "colorways/Navy"
  }
}

Purchase Orders

5 Endpoints

Import ERP rows, track readiness and publish per order.

GET/api/v1/purchase-ordersScope purchaseOrder:read

List purchase orders

Creation order, newest first, with live product counts.

ParameterInTypeDescription
qquerystringSearch PO number or supplier
updatedSincequerystring (date-time)Only purchase orders updated at or after this ISO 8601 timestamp (incremental sync)
cursorquerystringOpaque cursor from the previous page meta.nextCursor
limitqueryintegerPage size (default 50, max 200)
Example request
curl -X GET "https://www.seamdex.com/api/v1/purchase-orders?updatedSince=2026-09-01T00%3A00%3A00Z&limit=50" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "id": "66d0a1b2c3d4e5f6a7b8c9e1",
      "poNumber": "PO2001",
      "supplierName": "Mill Co",
      "etd": "2026-10-01",
      "eta": "2026-11-15",
      "state": "in_progress",
      "products": {
        "total": 6,
        "published": 2,
        "pendingChanges": 0
      },
      "createdAt": "2026-09-08T09:00:00.000Z",
      "updatedAt": "2026-09-08T09:00:00.000Z"
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null,
    "total": 1
  }
}
POST/api/v1/purchase-orders/importScope purchaseOrder:create

Import purchase order rows

One row per SKU (style x size x color). Rows are grouped by style into draft products under their PO; the quality text is parsed into a fibre composition. Idempotent: re-sending updates the same drafts and never touches published products. A style must not appear under two PO numbers in one request. Up to 20,000 rows, 500 styles and 4 MB per request.

Example request
curl -X POST "https://www.seamdex.com/api/v1/purchase-orders/import" \
  -H "Authorization: Bearer sdx_..." \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"styleNumber":"SR226-602","garmentName":"Wool Jacket","poNumber":"PO2001","supplierName":"Mill Co","color":"Navy","size":"M","qty":240,"barcode":"5712952970021","hsCode":"6203","countryOfOrigin":"Portugal","etd":"2026-10-01","eta":"2026-11-15","season":"SS27","market":"FR","quality":"60% Cotton - Organic 38% Cotton 2% Elastane","imageUrl":"https://cdn.example.com/sr226-602-navy.jpg"},{"styleNumber":"SR226-602","garmentName":"Wool Jacket","poNumber":"PO2001","supplierName":"Mill Co","color":"Navy","size":"S","qty":120,"barcode":"5712952970014","hsCode":"6203","countryOfOrigin":"Portugal","etd":"2026-10-01","eta":"2026-11-15","season":"SS27","market":"FR","quality":"60% Cotton - Organic 38% Cotton 2% Elastane","imageUrl":"https://cdn.example.com/sr226-602-navy.jpg"}]}'
Request body
{
  "rows": [
    {
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "poNumber": "PO2001",
      "supplierName": "Mill Co",
      "color": "Navy",
      "size": "M",
      "qty": 240,
      "barcode": "5712952970021",
      "hsCode": "6203",
      "countryOfOrigin": "Portugal",
      "etd": "2026-10-01",
      "eta": "2026-11-15",
      "season": "SS27",
      "market": "FR",
      "quality": "60% Cotton - Organic 38% Cotton 2% Elastane",
      "imageUrl": "https://cdn.example.com/sr226-602-navy.jpg"
    },
    {
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "poNumber": "PO2001",
      "supplierName": "Mill Co",
      "color": "Navy",
      "size": "S",
      "qty": 120,
      "barcode": "5712952970014",
      "hsCode": "6203",
      "countryOfOrigin": "Portugal",
      "etd": "2026-10-01",
      "eta": "2026-11-15",
      "season": "SS27",
      "market": "FR",
      "quality": "60% Cotton - Organic 38% Cotton 2% Elastane",
      "imageUrl": "https://cdn.example.com/sr226-602-navy.jpg"
    }
  ]
}
Response 200
{
  "data": {
    "summary": {
      "created": 1,
      "updated": 0,
      "skippedPublished": 0,
      "carried": 0,
      "pos": 1
    },
    "purchaseOrders": [
      {
        "id": "66d0a1b2c3d4e5f6a7b8c9e1",
        "poNumber": "PO2001",
        "productIds": [
          "66d0a1b2c3d4e5f6a7b8c9d0"
        ],
        "skippedStyles": []
      }
    ],
    "warnings": []
  }
}
GET/api/v1/purchase-orders/{id}Scope purchaseOrder:read

Get a purchase order with product readiness

The PO header, a rollup and one readiness row per product (blockers included), the same figures the app shows on the PO page.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X GET "https://www.seamdex.com/api/v1/purchase-orders/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9e1",
    "poNumber": "PO2001",
    "supplierName": "Mill Co",
    "etd": "2026-10-01",
    "eta": "2026-11-15",
    "sourceFile": {
      "name": "API PO2001"
    },
    "importedStyles": [
      "SR226-602"
    ],
    "rollup": {
      "total": 1,
      "published": 0,
      "drafts": 1,
      "ready": 0,
      "blocked": 1,
      "pendingChanges": 0,
      "state": "in_progress"
    },
    "products": [
      {
        "id": "66d0a1b2c3d4e5f6a7b8c9d0",
        "styleNumber": "SR226-602",
        "garmentName": "Wool Jacket",
        "status": "draft",
        "pendingChanges": false,
        "publishedAt": null,
        "certComplete": true,
        "certState": "noData",
        "missingCerts": [],
        "passportCount": 0,
        "ready": false,
        "notStarted": true,
        "blockers": [
          {
            "field": "identity.eoName",
            "tab": "identity",
            "msg": "Economic Operator name is required"
          }
        ]
      }
    ]
  }
}
DELETE/api/v1/purchase-orders/{id}Scope purchaseOrder:delete

Delete a purchase order and its drafts

Refused with 409 po_has_published_products while any product on it is published.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X DELETE "https://www.seamdex.com/api/v1/purchase-orders/66d0a1b2c3d4e5f6a7b8c9d0" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "id": "66d0a1b2c3d4e5f6a7b8c9e1",
    "poNumber": "PO2001",
    "deleted": true,
    "deletedProducts": 6
  }
}
POST/api/v1/purchase-orders/{id}/publishScope product:publish

Publish every ready draft on a purchase order

Publishes up to 100 drafts that pass the publish gate per call and reports the rest under skipped with their blockers. Call again while meta.remainingDrafts is above zero. Published products with pending changes are left alone.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X POST "https://www.seamdex.com/api/v1/purchase-orders/66d0a1b2c3d4e5f6a7b8c9d0/publish" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "purchaseOrderId": "66d0a1b2c3d4e5f6a7b8c9e1",
    "poNumber": "PO2001",
    "draftCount": 2,
    "published": [
      {
        "id": "66d0a1b2c3d4e5f6a7b8c9d0",
        "styleNumber": "SR226-602",
        "passportCount": 4
      }
    ],
    "skipped": [
      {
        "id": "66d0a1b2c3d4e5f6a7b8c9d1",
        "styleNumber": "SR226-603",
        "reason": "blockers",
        "blockers": [
          {
            "field": "identity.eoName",
            "tab": "identity",
            "msg": "Economic Operator name is required"
          }
        ]
      }
    ]
  },
  "meta": {
    "remainingDrafts": 0
  }
}

EPR Data

4 Endpoints

Weights and material figures for EPR reporting.

GET/api/v1/purchase-orders/{id}/eprScope purchaseOrder:read

EPR figures for a purchase order

Per-garment weight, fibre breakdown, recycled content and packaging for every product on the PO (all statuses). Published garments report their frozen publish-time figures.

ParameterInTypeDescription
id requiredpathstringThe resource id
Example request
curl -X GET "https://www.seamdex.com/api/v1/purchase-orders/66d0a1b2c3d4e5f6a7b8c9d0/epr" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "scope": {
      "type": "purchaseOrder",
      "purchaseOrderId": "66d0a1b2c3d4e5f6a7b8c9e1",
      "poNumber": "PO2001"
    },
    "rowCount": 1,
    "garments": [
      {
        "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
        "poNumber": "PO2001",
        "styleNumber": "SR226-602",
        "garmentName": "Wool Jacket",
        "status": "published",
        "publishedAt": "2026-09-08",
        "totalQuantity": 480,
        "garmentWeightG": 412.5,
        "fibres": [
          {
            "label": "Cotton",
            "weightG": 247.5,
            "sharePct": 60
          }
        ],
        "microplasticFlag": false
      }
    ],
    "fibres": []
  }
}
GET/api/v1/eprScope product:read

EPR figures for the garments in a period

Products in a period (UTC day bounds). basis=published, the default: products whose latest publish falls inside [from, to]. basis=eta: every non-archived product on purchase orders whose ETA falls inside the period, a purchase order without a parseable ETA counting by its latest publish, which is what the EPR report table shows. At most 5,000 products per range; narrow the dates otherwise.

ParameterInTypeDescription
from requiredquerystring (date)
to requiredquerystring (date)
basisqueryeta | publishedeta = purchase order ETA (the EPR report basis), published = passport publish date
Example request
curl -X GET "https://www.seamdex.com/api/v1/epr?from=2026-07-01&to=2026-09-30" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "scope": {
      "type": "publishedRange",
      "from": "2026-07-01",
      "to": "2026-09-30",
      "basis": "published"
    },
    "rowCount": 0,
    "garments": [],
    "fibres": [],
    "packaging": []
  }
}
GET/api/v1/epr/schemesScope product:read

EPR scheme templates

The national scheme templates Seamdex can produce a filing for, with their categories, checklist, sources and the date each was last verified. Fees are never computed.

Example request
curl -X GET "https://www.seamdex.com/api/v1/epr/schemes" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "id": "fr-refashion",
      "country": "FR",
      "name": "France, Refashion (textiles)",
      "pro": "Refashion",
      "status": "live",
      "unit": "pieces",
      "period": "calendar-year",
      "deadline": {
        "month": 2,
        "day": 28,
        "note": "Annual declaration of the previous year on the Refashion portal; supporting documents by 30 November."
      },
      "verifiedOn": "2026-09-23",
      "categories": [
        {
          "id": "clothing_medium",
          "label": "Clothing, medium pieces",
          "internal": [
            "tops"
          ]
        }
      ],
      "checklist": [
        "Register with Refashion as a producer."
      ],
      "sources": [
        {
          "label": "Refashion producer portal",
          "url": "https://pro.refashion.fr",
          "verifiedOn": "2026-09-23"
        }
      ],
      "hasEcoModulation": true,
      "note": null
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null
  }
}
GET/api/v1/epr/filings/{schemeId}Scope product:read

EPR filing preview for a scheme and period

Pieces and kilograms per scheme category for one market and calendar period, allocated by each purchase order's markets (or the organization default), with unmapped products and unallocated orders listed. Read-only; generating the workbook happens in the app.

ParameterInTypeDescription
schemeId requiredpathstringA scheme id from /epr/schemes
from requiredquerystring (date)
to requiredquerystring (date)
basisqueryeta | publishedWhich date places a product in the period
countryquerystringMarket country for the generic layout (ignored for national schemes)
Example request
curl -X GET "https://www.seamdex.com/api/v1/epr/filings/66d0a1b2c3d4e5f6a7b8c9d0?from=2026-01-01&to=2026-12-31" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "scheme": "fr-refashion",
    "country": "FR",
    "period": {
      "from": "2026-01-01",
      "to": "2026-12-31",
      "basis": "eta"
    },
    "unit": "pieces",
    "verifiedOn": "2026-09-23",
    "truncated": false,
    "totals": [
      {
        "categoryId": "clothing_medium",
        "label": "Clothing, medium pieces",
        "pieces": 1200,
        "kg": 240,
        "packagingKg": 12,
        "products": 4
      }
    ],
    "pieces": 1200,
    "kg": 240,
    "productCount": 4,
    "products": [],
    "unmapped": [],
    "unallocated": [
      {
        "poNumber": "PO2002",
        "pieces": 300
      }
    ]
  }
}

Retailer Feeds

1 Endpoint

Product attribute rows in retailer layouts, with the passport link per size.

GET/api/v1/feeds/{templateId}Scope product:read

Retailer feed rows

One object per size and colour, keyed by the template's column keys (generic, aboutyou, zalando, boozt, asos, netaporter); the aboutyou-sustainability template instead yields one object per style and sustainability claim (cluster, made-with, share, proof, certificate number). Published products export their passport data; listing text and prices are read live. Drafts are left out unless includeDrafts=true. Paged by product.

ParameterInTypeDescription
templateId requiredpathstringgeneric, aboutyou, aboutyou-sustainability, zalando, boozt, asos or netaporter
poIdquerystringScope to one purchase order
includeDraftsquerytrue | false
cursorquerystringOpaque cursor from the previous page meta.nextCursor
limitqueryintegerPage size (default 50, max 200)
Example request
curl -X GET "https://www.seamdex.com/api/v1/feeds/66d0a1b2c3d4e5f6a7b8c9d0?limit=50" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "brand": "Demo Brand",
      "styleNumber": "SR226-602",
      "styleName": "Wool Jacket",
      "color": "Navy",
      "size": "M",
      "ean": "4006381333931",
      "composition": "80% Wool, 20% Polyester",
      "passportUrl": "https://www.seamdex.com/01/05712345678904/21/seamdexdemo0"
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null,
    "template": "generic",
    "verifiedOn": "2026-09-23",
    "skipped": [],
    "draftsLeftOut": 0
  }
}

Passports

3 Endpoints

Published passports and their QR codes.

GET/api/v1/passportsScope product:read

List passports

Pages over published products (limit counts products) and returns every passport of the products on the page. Retired passports (superseded sizes that still resolve) are excluded unless includeRetired=true.

ParameterInTypeDescription
productIdquerystring
purchaseOrderIdquerystring
gtinquerystring8 to 14 digits; padded and unpadded forms match
scopequerysize | colorsize = one passport per size (default kind), color = the optional per-colourway style QR
includeRetiredqueryboolean
publishedSincequerystring (date-time)Only products published at or after this ISO 8601 timestamp (incremental sync)
cursorquerystringOpaque cursor from the previous page meta.nextCursor
limitqueryintegerPage size (default 50, max 200)
Example request
curl -X GET "https://www.seamdex.com/api/v1/passports?publishedSince=2026-09-01T00%3A00%3A00Z&limit=50" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": [
    {
      "dppId": "Xk7Pq2mN9vRt",
      "gtin": "5712952970021",
      "gtin14": "05712952970021",
      "size": "M",
      "color": "Navy",
      "scope": "size",
      "retired": false,
      "path": "/01/05712952970021/21/Xk7Pq2mN9vRt",
      "url": "https://www.dpp.seamdex.com/01/05712952970021/21/Xk7Pq2mN9vRt",
      "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
      "styleNumber": "SR226-602",
      "garmentName": "Wool Jacket",
      "publishedAt": "2026-09-08T09:12:44.000Z",
      "publishVersion": 1
    }
  ],
  "meta": {
    "hasMore": false,
    "nextCursor": null
  }
}
GET/api/v1/passports/{dppId}Scope product:read

Get a passport

ParameterInTypeDescription
dppId requiredpathstringThe passport id (the /21/ segment of the passport URL)
Example request
curl -X GET "https://www.seamdex.com/api/v1/passports/Xk7Pq2mN9vRt" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "dppId": "Xk7Pq2mN9vRt",
    "gtin": "5712952970021",
    "gtin14": "05712952970021",
    "size": "M",
    "color": "Navy",
    "scope": "size",
    "retired": false,
    "path": "/01/05712952970021/21/Xk7Pq2mN9vRt",
    "url": "https://www.dpp.seamdex.com/01/05712952970021/21/Xk7Pq2mN9vRt",
    "productId": "66d0a1b2c3d4e5f6a7b8c9d0",
    "styleNumber": "SR226-602",
    "garmentName": "Wool Jacket",
    "publishedAt": "2026-09-08T09:12:44.000Z",
    "publishVersion": 1
  }
}
GET/api/v1/passports/{dppId}/qrScope product:read

QR code for a passport

The QR encodes the canonical passport URL (a verified custom domain wins over the platform host). PNG comes back as a base64 data URI, SVG as markup; both are JSON strings. Retired passports are flagged: do not print them on new garments.

ParameterInTypeDescription
dppId requiredpathstringThe passport id (the /21/ segment of the passport URL)
formatquerypng | svg
sizequeryintegerPixels (PNG) or viewBox size (SVG)
Example request
curl -X GET "https://www.seamdex.com/api/v1/passports/Xk7Pq2mN9vRt/qr" \
  -H "Authorization: Bearer sdx_..."
Response 200
{
  "data": {
    "dppId": "Xk7Pq2mN9vRt",
    "url": "https://www.dpp.seamdex.com/01/05712952970021/21/Xk7Pq2mN9vRt",
    "retired": false,
    "format": "png",
    "size": 512,
    "image": "data:image/png;base64,iVBORw0KGgo..."
  }
}

Product fields

The sections a product body may carry, straight from the data model. Arrays are written as field[]. Enumerated values are listed; everything else is free text, a number, a boolean or a date. Read-only fields (status, computed figures, passports) are never accepted in a body.

Mode mode
FieldTypeValues
modestringlightfull
Basics basics
FieldTypeValues
basics.styleNumberstring
basics.garmentNamestring
basics.seasonstring
basics.colorstring
basics.eanstring
basics.hsCodestring
basics.countryOfOriginstring
basics.dppNumberstring
basics.poQuantitynumber
basics.images[].namestring
basics.images[].urlstring
basics.images[].sourceUrlstring
basics.sizeGuide.namestring
basics.sizeGuide.urlstring
basics.sizeGuide.sourceUrlstring
basics.sizeGuideIdstring
Identity identity
FieldTypeValues
identity.eoSupplierIdstring
identity.eoNamestring
identity.eoNameLocalstring
identity.eoCountrystring
identity.eoUidstring
identity.eoPostalstring
identity.eoAddressstring
identity.eoEmailstring
identity.eoWebstring
identity.eoCerts[].namestring
identity.eoCerts[].typestringdefault Scope
identity.eoCerts[].claimstring
identity.eoCerts[].fiberstring
identity.eoCerts[].issuedate
identity.eoCerts[].expirydate
identity.eoCerts[].numberstring
identity.eoCerts[].bodystring
identity.eoCerts[].auditdate
identity.eoCerts[].files[].namestring
identity.eoCerts[].files[].urlstring
identity.eoCerts[].files[].sourceUrlstring
identity.eoCerts[].itemTypesarray of string
identity.eoCerts[].certificateIdstring
identity.assemblyFactory.supplierIdstring
identity.assemblyFactory.namestring
identity.assemblyFactory.nameLocalstring
identity.assemblyFactory.countrystring
identity.assemblyFactory.postalstring
identity.assemblyFactory.addrstring
identity.assemblyFactory.midstring
identity.assemblyFactory.certs[].namestring
identity.assemblyFactory.certs[].typestringdefault Scope
identity.assemblyFactory.certs[].claimstring
identity.assemblyFactory.certs[].fiberstring
identity.assemblyFactory.certs[].issuedate
identity.assemblyFactory.certs[].expirydate
identity.assemblyFactory.certs[].numberstring
identity.assemblyFactory.certs[].bodystring
identity.assemblyFactory.certs[].auditdate
identity.assemblyFactory.certs[].files[].namestring
identity.assemblyFactory.certs[].files[].urlstring
identity.assemblyFactory.certs[].files[].sourceUrlstring
identity.assemblyFactory.certs[].itemTypesarray of string
identity.assemblyFactory.certs[].certificateIdstring
identity.assemblyFactory.disclosurestringsuppliercountry
identity.washPlant.supplierIdstring
identity.washPlant.namestring
identity.washPlant.nameLocalstring
identity.washPlant.countrystring
identity.washPlant.postalstring
identity.washPlant.addrstring
identity.washPlant.midstring
identity.washPlant.certs[].namestring
identity.washPlant.certs[].typestringdefault Scope
identity.washPlant.certs[].claimstring
identity.washPlant.certs[].fiberstring
identity.washPlant.certs[].issuedate
identity.washPlant.certs[].expirydate
identity.washPlant.certs[].numberstring
identity.washPlant.certs[].bodystring
identity.washPlant.certs[].auditdate
identity.washPlant.certs[].files[].namestring
identity.washPlant.certs[].files[].urlstring
identity.washPlant.certs[].files[].sourceUrlstring
identity.washPlant.certs[].itemTypesarray of string
identity.washPlant.certs[].certificateIdstring
identity.washPlant.disclosurestringsuppliercountry
Composition composition
FieldTypeValues
composition.garmentTypestringwovencircular_knitknitleatheraccessory
composition.wovenLayers[].layerTypestring
composition.wovenLayers[].layerCustomNamestring
composition.wovenLayers[].fabricKindstringwovencircular_knit
composition.wovenLayers[].gsmnumber
composition.wovenLayers[].widthnumber
composition.wovenLayers[].consumptionnumber
composition.wovenLayers[].weightModestringgsmweight
composition.wovenLayers[].weightGnumber
composition.wovenLayers[].weaveTypestring
composition.wovenLayers[].dyesarray of string
composition.wovenLayers[].printsarray of string
composition.wovenLayers[].fabricConstructionstring
composition.wovenLayers[].componentWeightGnumber
composition.wovenLayers[].fibers[].fiberTypestring
composition.wovenLayers[].fibers[].percentagenumber
composition.wovenLayers[].fibers[].countrystring
composition.wovenLayers[].fibers[].recycledTypestring
composition.wovenLayers[].fibers[].nylonTypestring
composition.wovenLayers[].fibers[].fiberWeightGnumber
composition.wovenLayers[].fibers[].matchedboolean
composition.wovenLayers[].fibers[].rawstring
composition.wovenLayers[].supply.t1.supplierIdstring
composition.wovenLayers[].supply.t1.namestring
composition.wovenLayers[].supply.t1.nameLocalstring
composition.wovenLayers[].supply.t1.countrystring
composition.wovenLayers[].supply.t1.postalstring
composition.wovenLayers[].supply.t1.addrstring
composition.wovenLayers[].supply.t1.midstring
composition.wovenLayers[].supply.t1.certs[].namestring
composition.wovenLayers[].supply.t1.certs[].typestringdefault Scope
composition.wovenLayers[].supply.t1.certs[].claimstring
composition.wovenLayers[].supply.t1.certs[].fiberstring
composition.wovenLayers[].supply.t1.certs[].issuedate
composition.wovenLayers[].supply.t1.certs[].expirydate
composition.wovenLayers[].supply.t1.certs[].numberstring
composition.wovenLayers[].supply.t1.certs[].bodystring
composition.wovenLayers[].supply.t1.certs[].auditdate
composition.wovenLayers[].supply.t1.certs[].files[].namestring
composition.wovenLayers[].supply.t1.certs[].files[].urlstring
composition.wovenLayers[].supply.t1.certs[].files[].sourceUrlstring
composition.wovenLayers[].supply.t1.certs[].itemTypesarray of string
composition.wovenLayers[].supply.t1.certs[].certificateIdstring
composition.wovenLayers[].supply.t1.disclosurestringsuppliercountry
composition.wovenLayers[].supply.t2.supplierIdstring
composition.wovenLayers[].supply.t2.namestring
composition.wovenLayers[].supply.t2.nameLocalstring
composition.wovenLayers[].supply.t2.countrystring
composition.wovenLayers[].supply.t2.postalstring
composition.wovenLayers[].supply.t2.addrstring
composition.wovenLayers[].supply.t2.midstring
composition.wovenLayers[].supply.t2.certs[].namestring
composition.wovenLayers[].supply.t2.certs[].typestringdefault Scope
composition.wovenLayers[].supply.t2.certs[].claimstring
composition.wovenLayers[].supply.t2.certs[].fiberstring
composition.wovenLayers[].supply.t2.certs[].issuedate
composition.wovenLayers[].supply.t2.certs[].expirydate
composition.wovenLayers[].supply.t2.certs[].numberstring
composition.wovenLayers[].supply.t2.certs[].bodystring
composition.wovenLayers[].supply.t2.certs[].auditdate
composition.wovenLayers[].supply.t2.certs[].files[].namestring
composition.wovenLayers[].supply.t2.certs[].files[].urlstring
composition.wovenLayers[].supply.t2.certs[].files[].sourceUrlstring
composition.wovenLayers[].supply.t2.certs[].itemTypesarray of string
composition.wovenLayers[].supply.t2.certs[].certificateIdstring
composition.wovenLayers[].supply.t2.disclosurestringsuppliercountry
composition.wovenLayers[].supply.t2b.supplierIdstring
composition.wovenLayers[].supply.t2b.namestring
composition.wovenLayers[].supply.t2b.nameLocalstring
composition.wovenLayers[].supply.t2b.countrystring
composition.wovenLayers[].supply.t2b.postalstring
composition.wovenLayers[].supply.t2b.addrstring
composition.wovenLayers[].supply.t2b.midstring
composition.wovenLayers[].supply.t2b.certs[].namestring
composition.wovenLayers[].supply.t2b.certs[].typestringdefault Scope
composition.wovenLayers[].supply.t2b.certs[].claimstring
composition.wovenLayers[].supply.t2b.certs[].fiberstring
composition.wovenLayers[].supply.t2b.certs[].issuedate
composition.wovenLayers[].supply.t2b.certs[].expirydate
composition.wovenLayers[].supply.t2b.certs[].numberstring
composition.wovenLayers[].supply.t2b.certs[].bodystring
composition.wovenLayers[].supply.t2b.certs[].auditdate
composition.wovenLayers[].supply.t2b.certs[].files[].namestring
composition.wovenLayers[].supply.t2b.certs[].files[].urlstring
composition.wovenLayers[].supply.t2b.certs[].files[].sourceUrlstring
composition.wovenLayers[].supply.t2b.certs[].itemTypesarray of string
composition.wovenLayers[].supply.t2b.certs[].certificateIdstring
composition.wovenLayers[].supply.t2b.disclosurestringsuppliercountry
composition.wovenLayers[].supply.t3.supplierIdstring
composition.wovenLayers[].supply.t3.namestring
composition.wovenLayers[].supply.t3.nameLocalstring
composition.wovenLayers[].supply.t3.countrystring
composition.wovenLayers[].supply.t3.postalstring
composition.wovenLayers[].supply.t3.addrstring
composition.wovenLayers[].supply.t3.midstring
composition.wovenLayers[].supply.t3.certs[].namestring
composition.wovenLayers[].supply.t3.certs[].typestringdefault Scope
composition.wovenLayers[].supply.t3.certs[].claimstring
composition.wovenLayers[].supply.t3.certs[].fiberstring
composition.wovenLayers[].supply.t3.certs[].issuedate
composition.wovenLayers[].supply.t3.certs[].expirydate
composition.wovenLayers[].supply.t3.certs[].numberstring
composition.wovenLayers[].supply.t3.certs[].bodystring
composition.wovenLayers[].supply.t3.certs[].auditdate
composition.wovenLayers[].supply.t3.certs[].files[].namestring
composition.wovenLayers[].supply.t3.certs[].files[].urlstring
composition.wovenLayers[].supply.t3.certs[].files[].sourceUrlstring
composition.wovenLayers[].supply.t3.certs[].itemTypesarray of string
composition.wovenLayers[].supply.t3.certs[].certificateIdstring
composition.wovenLayers[].supply.t3.disclosurestringsuppliercountry
composition.wovenLayers[].supply.t4.supplierIdstring
composition.wovenLayers[].supply.t4.namestring
composition.wovenLayers[].supply.t4.nameLocalstring
composition.wovenLayers[].supply.t4.countrystring
composition.wovenLayers[].supply.t4.postalstring
composition.wovenLayers[].supply.t4.addrstring
composition.wovenLayers[].supply.t4.midstring
composition.wovenLayers[].supply.t4.certs[].namestring
composition.wovenLayers[].supply.t4.certs[].typestringdefault Scope
composition.wovenLayers[].supply.t4.certs[].claimstring
composition.wovenLayers[].supply.t4.certs[].fiberstring
composition.wovenLayers[].supply.t4.certs[].issuedate
composition.wovenLayers[].supply.t4.certs[].expirydate
composition.wovenLayers[].supply.t4.certs[].numberstring
composition.wovenLayers[].supply.t4.certs[].bodystring
composition.wovenLayers[].supply.t4.certs[].auditdate
composition.wovenLayers[].supply.t4.certs[].files[].namestring
composition.wovenLayers[].supply.t4.certs[].files[].urlstring
composition.wovenLayers[].supply.t4.certs[].files[].sourceUrlstring
composition.wovenLayers[].supply.t4.certs[].itemTypesarray of string
composition.wovenLayers[].supply.t4.certs[].certificateIdstring
composition.wovenLayers[].supply.t4.disclosurestringsuppliercountry
composition.wovenLayers[].sourceComponentIdstring
composition.wovenLayers[].snapshot.sourceIdstring
composition.wovenLayers[].snapshot.sourceModelstring
composition.wovenLayers[].snapshot.sourceLabelstring
composition.wovenLayers[].snapshot.snapshotAtdate
composition.wovenLayers[].snapshot.sourceUpdatedAtdate
composition.knitWeightnumber
composition.knitStructurestring
composition.knitBlocks[].yarnCountstring
composition.knitBlocks[].knitStructurestring
composition.knitBlocks[].dyesarray of string
composition.knitBlocks[].printsarray of string
composition.knitBlocks[].sharenumber
composition.knitBlocks[].fibers[].fiberTypestring
composition.knitBlocks[].fibers[].percentagenumber
composition.knitBlocks[].fibers[].countrystring
composition.knitBlocks[].fibers[].recycledTypestring
composition.knitBlocks[].fibers[].nylonTypestring
composition.knitBlocks[].fibers[].fiberWeightGnumber
composition.knitBlocks[].fibers[].matchedboolean
composition.knitBlocks[].fibers[].rawstring
composition.knitBlocks[].supply.t1.supplierIdstring
composition.knitBlocks[].supply.t1.namestring
composition.knitBlocks[].supply.t1.nameLocalstring
composition.knitBlocks[].supply.t1.countrystring
composition.knitBlocks[].supply.t1.postalstring
composition.knitBlocks[].supply.t1.addrstring
composition.knitBlocks[].supply.t1.midstring
composition.knitBlocks[].supply.t1.certs[].namestring
composition.knitBlocks[].supply.t1.certs[].typestringdefault Scope
composition.knitBlocks[].supply.t1.certs[].claimstring
composition.knitBlocks[].supply.t1.certs[].fiberstring
composition.knitBlocks[].supply.t1.certs[].issuedate
composition.knitBlocks[].supply.t1.certs[].expirydate
composition.knitBlocks[].supply.t1.certs[].numberstring
composition.knitBlocks[].supply.t1.certs[].bodystring
composition.knitBlocks[].supply.t1.certs[].auditdate
composition.knitBlocks[].supply.t1.certs[].files[].namestring
composition.knitBlocks[].supply.t1.certs[].files[].urlstring
composition.knitBlocks[].supply.t1.certs[].files[].sourceUrlstring
composition.knitBlocks[].supply.t1.certs[].itemTypesarray of string
composition.knitBlocks[].supply.t1.certs[].certificateIdstring
composition.knitBlocks[].supply.t1.disclosurestringsuppliercountry
composition.knitBlocks[].supply.t2.supplierIdstring
composition.knitBlocks[].supply.t2.namestring
composition.knitBlocks[].supply.t2.nameLocalstring
composition.knitBlocks[].supply.t2.countrystring
composition.knitBlocks[].supply.t2.postalstring
composition.knitBlocks[].supply.t2.addrstring
composition.knitBlocks[].supply.t2.midstring
composition.knitBlocks[].supply.t2.certs[].namestring
composition.knitBlocks[].supply.t2.certs[].typestringdefault Scope
composition.knitBlocks[].supply.t2.certs[].claimstring
composition.knitBlocks[].supply.t2.certs[].fiberstring
composition.knitBlocks[].supply.t2.certs[].issuedate
composition.knitBlocks[].supply.t2.certs[].expirydate
composition.knitBlocks[].supply.t2.certs[].numberstring
composition.knitBlocks[].supply.t2.certs[].bodystring
composition.knitBlocks[].supply.t2.certs[].auditdate
composition.knitBlocks[].supply.t2.certs[].files[].namestring
composition.knitBlocks[].supply.t2.certs[].files[].urlstring
composition.knitBlocks[].supply.t2.certs[].files[].sourceUrlstring
composition.knitBlocks[].supply.t2.certs[].itemTypesarray of string
composition.knitBlocks[].supply.t2.certs[].certificateIdstring
composition.knitBlocks[].supply.t2.disclosurestringsuppliercountry
composition.knitBlocks[].supply.t2b.supplierIdstring
composition.knitBlocks[].supply.t2b.namestring
composition.knitBlocks[].supply.t2b.nameLocalstring
composition.knitBlocks[].supply.t2b.countrystring
composition.knitBlocks[].supply.t2b.postalstring
composition.knitBlocks[].supply.t2b.addrstring
composition.knitBlocks[].supply.t2b.midstring
composition.knitBlocks[].supply.t2b.certs[].namestring
composition.knitBlocks[].supply.t2b.certs[].typestringdefault Scope
composition.knitBlocks[].supply.t2b.certs[].claimstring
composition.knitBlocks[].supply.t2b.certs[].fiberstring
composition.knitBlocks[].supply.t2b.certs[].issuedate
composition.knitBlocks[].supply.t2b.certs[].expirydate
composition.knitBlocks[].supply.t2b.certs[].numberstring
composition.knitBlocks[].supply.t2b.certs[].bodystring
composition.knitBlocks[].supply.t2b.certs[].auditdate
composition.knitBlocks[].supply.t2b.certs[].files[].namestring
composition.knitBlocks[].supply.t2b.certs[].files[].urlstring
composition.knitBlocks[].supply.t2b.certs[].files[].sourceUrlstring
composition.knitBlocks[].supply.t2b.certs[].itemTypesarray of string
composition.knitBlocks[].supply.t2b.certs[].certificateIdstring
composition.knitBlocks[].supply.t2b.disclosurestringsuppliercountry
composition.knitBlocks[].supply.t3.supplierIdstring
composition.knitBlocks[].supply.t3.namestring
composition.knitBlocks[].supply.t3.nameLocalstring
composition.knitBlocks[].supply.t3.countrystring
composition.knitBlocks[].supply.t3.postalstring
composition.knitBlocks[].supply.t3.addrstring
composition.knitBlocks[].supply.t3.midstring
composition.knitBlocks[].supply.t3.certs[].namestring
composition.knitBlocks[].supply.t3.certs[].typestringdefault Scope
composition.knitBlocks[].supply.t3.certs[].claimstring
composition.knitBlocks[].supply.t3.certs[].fiberstring
composition.knitBlocks[].supply.t3.certs[].issuedate
composition.knitBlocks[].supply.t3.certs[].expirydate
composition.knitBlocks[].supply.t3.certs[].numberstring
composition.knitBlocks[].supply.t3.certs[].bodystring
composition.knitBlocks[].supply.t3.certs[].auditdate
composition.knitBlocks[].supply.t3.certs[].files[].namestring
composition.knitBlocks[].supply.t3.certs[].files[].urlstring
composition.knitBlocks[].supply.t3.certs[].files[].sourceUrlstring
composition.knitBlocks[].supply.t3.certs[].itemTypesarray of string
composition.knitBlocks[].supply.t3.certs[].certificateIdstring
composition.knitBlocks[].supply.t3.disclosurestringsuppliercountry
composition.knitBlocks[].supply.t4.supplierIdstring
composition.knitBlocks[].supply.t4.namestring
composition.knitBlocks[].supply.t4.nameLocalstring
composition.knitBlocks[].supply.t4.countrystring
composition.knitBlocks[].supply.t4.postalstring
composition.knitBlocks[].supply.t4.addrstring
composition.knitBlocks[].supply.t4.midstring
composition.knitBlocks[].supply.t4.certs[].namestring
composition.knitBlocks[].supply.t4.certs[].typestringdefault Scope
composition.knitBlocks[].supply.t4.certs[].claimstring
composition.knitBlocks[].supply.t4.certs[].fiberstring
composition.knitBlocks[].supply.t4.certs[].issuedate
composition.knitBlocks[].supply.t4.certs[].expirydate
composition.knitBlocks[].supply.t4.certs[].numberstring
composition.knitBlocks[].supply.t4.certs[].bodystring
composition.knitBlocks[].supply.t4.certs[].auditdate
composition.knitBlocks[].supply.t4.certs[].files[].namestring
composition.knitBlocks[].supply.t4.certs[].files[].urlstring
composition.knitBlocks[].supply.t4.certs[].files[].sourceUrlstring
composition.knitBlocks[].supply.t4.certs[].itemTypesarray of string
composition.knitBlocks[].supply.t4.certs[].certificateIdstring
composition.knitBlocks[].supply.t4.disclosurestringsuppliercountry
composition.knitBlocks[].sourceComponentIdstring
composition.knitBlocks[].snapshot.sourceIdstring
composition.knitBlocks[].snapshot.sourceModelstring
composition.knitBlocks[].snapshot.sourceLabelstring
composition.knitBlocks[].snapshot.snapshotAtdate
composition.knitBlocks[].snapshot.sourceUpdatedAtdate
composition.hasSequinsboolean
composition.fiberCerts[].namestring
composition.fiberCerts[].typestringdefault Scope
composition.fiberCerts[].claimstring
composition.fiberCerts[].fiberstring
composition.fiberCerts[].issuedate
composition.fiberCerts[].expirydate
composition.fiberCerts[].numberstring
composition.fiberCerts[].bodystring
composition.fiberCerts[].auditdate
composition.fiberCerts[].files[].namestring
composition.fiberCerts[].files[].urlstring
composition.fiberCerts[].files[].sourceUrlstring
composition.fiberCerts[].itemTypesarray of string
composition.fiberCerts[].certificateIdstring
composition.fiberCerts[].addedBy.typestringbrandpartner
composition.fiberCerts[].addedBy.accessIdstring
composition.fiberCerts[].addedBy.namestring
composition.fiberCerts[].logo.logoIdstring
composition.fiberCerts[].logo.urlstring
composition.fiberCerts[].logo.namestring
composition.fiberCerts[].logo.sourcestringbrandpartner
composition.fiberCerts[].logo.manualboolean
Trims trims
FieldTypeValues
trims.thread.materialstring
trims.thread.weightGnumber
trims.thread.recycledTypestring
trims.thread.nylonTypestring
trims.thread.countrystring
trims.thread.supplierSnapshot.supplierIdstring
trims.thread.supplierSnapshot.namestring
trims.thread.supplierSnapshot.nameLocalstring
trims.thread.supplierSnapshot.countrystring
trims.thread.supplierSnapshot.postalstring
trims.thread.supplierSnapshot.addrstring
trims.thread.supplierSnapshot.midstring
trims.thread.supplierSnapshot.certs[].namestring
trims.thread.supplierSnapshot.certs[].typestringdefault Scope
trims.thread.supplierSnapshot.certs[].claimstring
trims.thread.supplierSnapshot.certs[].fiberstring
trims.thread.supplierSnapshot.certs[].issuedate
trims.thread.supplierSnapshot.certs[].expirydate
trims.thread.supplierSnapshot.certs[].numberstring
trims.thread.supplierSnapshot.certs[].bodystring
trims.thread.supplierSnapshot.certs[].auditdate
trims.thread.supplierSnapshot.certs[].files[].namestring
trims.thread.supplierSnapshot.certs[].files[].urlstring
trims.thread.supplierSnapshot.certs[].files[].sourceUrlstring
trims.thread.supplierSnapshot.certs[].itemTypesarray of string
trims.thread.supplierSnapshot.certs[].certificateIdstring
trims.thread.supplierSnapshot.disclosurestringsuppliercountry
trims.buttons[].materialstring
trims.buttons[].weightGnumber
trims.buttons[].qtynumber
trims.buttons[].countrystring
trims.buttons[].supplierSnapshot.supplierIdstring
trims.buttons[].supplierSnapshot.namestring
trims.buttons[].supplierSnapshot.nameLocalstring
trims.buttons[].supplierSnapshot.countrystring
trims.buttons[].supplierSnapshot.postalstring
trims.buttons[].supplierSnapshot.addrstring
trims.buttons[].supplierSnapshot.midstring
trims.buttons[].supplierSnapshot.certs[].namestring
trims.buttons[].supplierSnapshot.certs[].typestringdefault Scope
trims.buttons[].supplierSnapshot.certs[].claimstring
trims.buttons[].supplierSnapshot.certs[].fiberstring
trims.buttons[].supplierSnapshot.certs[].issuedate
trims.buttons[].supplierSnapshot.certs[].expirydate
trims.buttons[].supplierSnapshot.certs[].numberstring
trims.buttons[].supplierSnapshot.certs[].bodystring
trims.buttons[].supplierSnapshot.certs[].auditdate
trims.buttons[].supplierSnapshot.certs[].files[].namestring
trims.buttons[].supplierSnapshot.certs[].files[].urlstring
trims.buttons[].supplierSnapshot.certs[].files[].sourceUrlstring
trims.buttons[].supplierSnapshot.certs[].itemTypesarray of string
trims.buttons[].supplierSnapshot.certs[].certificateIdstring
trims.buttons[].supplierSnapshot.disclosurestringsuppliercountry
trims.zippers[].typestring
trims.zippers[].sliderstring
trims.zippers[].tapestring
trims.zippers[].weightGnumber
trims.zippers[].qtynumberdefault 1
trims.zippers[].countrystring
trims.zippers[].supplierSnapshot.supplierIdstring
trims.zippers[].supplierSnapshot.namestring
trims.zippers[].supplierSnapshot.nameLocalstring
trims.zippers[].supplierSnapshot.countrystring
trims.zippers[].supplierSnapshot.postalstring
trims.zippers[].supplierSnapshot.addrstring
trims.zippers[].supplierSnapshot.midstring
trims.zippers[].supplierSnapshot.certs[].namestring
trims.zippers[].supplierSnapshot.certs[].typestringdefault Scope
trims.zippers[].supplierSnapshot.certs[].claimstring
trims.zippers[].supplierSnapshot.certs[].fiberstring
trims.zippers[].supplierSnapshot.certs[].issuedate
trims.zippers[].supplierSnapshot.certs[].expirydate
trims.zippers[].supplierSnapshot.certs[].numberstring
trims.zippers[].supplierSnapshot.certs[].bodystring
trims.zippers[].supplierSnapshot.certs[].auditdate
trims.zippers[].supplierSnapshot.certs[].files[].namestring
trims.zippers[].supplierSnapshot.certs[].files[].urlstring
trims.zippers[].supplierSnapshot.certs[].files[].sourceUrlstring
trims.zippers[].supplierSnapshot.certs[].itemTypesarray of string
trims.zippers[].supplierSnapshot.certs[].certificateIdstring
trims.zippers[].supplierSnapshot.disclosurestringsuppliercountry
Packaging packaging
FieldTypeValues
packaging.components[].typestringpolybaghangtagsilkpapercardboardsilica
packaging.components[].statusstringbrand-designatedsupplier-sourcednot-applicable
packaging.components[].data.materialstring
packaging.components[].data.weight_gnumber
packaging.components[].data.recycled_pctnumber
packaging.components[].data.recycled_sourcestring
packaging.components[].data.certificationstring
packaging.components[].data.type_numberstring
packaging.components[].data.doc.namestring
packaging.components[].data.doc.urlstring
packaging.components[].data.doc.sourceUrlstring
packaging.components[].data.string_materialstring
packaging.components[].data.fastener_materialstring
packaging.components[].data.desiccant_fillingstring
packaging.components[].data.pouch_materialstring
packaging.components[].data.units_per_boxnumber
packaging.components[].data.fibre_pctnumber
packaging.components[].data.ink_typestring
packaging.components[].data.material_codestring
packaging.components[].data.printedstring
packaging.components[].data.ink_compliancestring
packaging.components[].data.pcr_pctnumber
packaging.components[].data.material_otherstring
packaging.components[].data.surface_treatmentstring
packaging.components[].data.plastic_formatstring
packaging.components[].data.colourstring
packaging.components[].data.carbon_blackstring
packaging.components[].data.supplier.supplierIdstring
packaging.components[].data.supplier.namestring
packaging.components[].data.supplier.nameLocalstring
packaging.components[].data.supplier.countrystring
packaging.components[].data.supplier.postalstring
packaging.components[].data.supplier.addrstring
packaging.components[].data.supplier.midstring
packaging.components[].data.supplier.certs[].namestring
packaging.components[].data.supplier.certs[].typestringdefault Scope
packaging.components[].data.supplier.certs[].claimstring
packaging.components[].data.supplier.certs[].fiberstring
packaging.components[].data.supplier.certs[].issuedate
packaging.components[].data.supplier.certs[].expirydate
packaging.components[].data.supplier.certs[].numberstring
packaging.components[].data.supplier.certs[].bodystring
packaging.components[].data.supplier.certs[].auditdate
packaging.components[].data.supplier.certs[].files[].namestring
packaging.components[].data.supplier.certs[].files[].urlstring
packaging.components[].data.supplier.certs[].files[].sourceUrlstring
packaging.components[].data.supplier.certs[].itemTypesarray of string
packaging.components[].data.supplier.certs[].certificateIdstring
packaging.components[].data.supplier.disclosurestringsuppliercountry
packaging.components[].sourceEntryIdstring
packaging.components[].snapshot.sourceIdstring
packaging.components[].snapshot.sourceModelstring
packaging.components[].snapshot.sourceLabelstring
packaging.components[].snapshot.snapshotAtdate
packaging.components[].snapshot.sourceUpdatedAtdate
Wash and Care care
FieldTypeValues
care.isWashedboolean
care.washesarray of string
care.treatmentsarray of string
care.careSymbolsarray of string
care.careExtrasarray of string
care.shrinkageSimplenumber
Performance and Impact performance
FieldTypeValues
performance.spiralitynumber
performance.dimChangenumber
performance.spiralityPctnumber
performance.dimChangePctnumber
performance.appearance.colourChange.gradestring
performance.appearance.colourChange.notestring
performance.appearance.pilling.gradestring
performance.appearance.pilling.notestring
performance.appearance.fuzzing.gradestring
performance.appearance.fuzzing.notestring
performance.appearance.seamAppearance.gradestring
performance.appearance.seamAppearance.notestring
performance.appearance.nonTextileParts.gradestring
performance.appearance.nonTextileParts.notestring
performance.co2Valuenumber
performance.co2Scopestring
performance.waterValuenumber
performance.scrapPctnumber
performance.ecobalyseProductstring
performance.footprint.methodstring
performance.footprint.versionstring
performance.footprint.scorenumber
performance.footprint.co2Kgnumber
performance.footprint.waterLnumber
performance.footprint.durabilitynumber
performance.footprint.productCategorystring
performance.footprint.inputsHashstring
performance.footprint.webUrlstring
performance.footprint.approximationsarray of string
performance.footprint.computedAtdate
Compliance compliance
FieldTypeValues
compliance.svhcCompliantbooleandefault true
compliance.annex14Compliantbooleandefault true
compliance.annex17Compliantbooleandefault true
compliance.popsCompliantbooleandefault true
compliance.ppwrCompliantbooleandefault true
compliance.complianceStatementstring
listing listing
FieldTypeValues
listing.titleobject
listing.title.$*string
listing.descriptionobject
listing.description.$*string
listing.genderstring
listing.ageGroupstring
listing.categoryPathstring
listing.sizeSystemstring
listing.keywordsarray of string
listing.prices[].currencystring
listing.prices[].amountnumber
listing.prices[].countrystring
Colorways colorways
FieldTypeValues
colorways[].namestring
colorways[].images[].namestring
colorways[].images[].urlstring
colorways[].images[].sourceUrlstring
Variants (sizes) variants
FieldTypeValues
variants[].sizestring
variants[].colorstring
variants[].eanstring
variants[].quantitynumber
Imported Composition importedComposition
FieldTypeValues
importedCompositionmixed
carriedFrom carriedFrom
FieldTypeValues
carriedFrom.productIdstring
carriedFrom.styleNumberstring
carriedFrom.poNumberstring
carriedFrom.seasonstring
carriedFrom.publishVersionnumber
carriedFrom.publishedAtdate
carriedFrom.carriedAtdate
carriedFrom.sectionsarray of string
carriedFrom.reviewedAtdate
carriedFrom.supplyChainConfirmedAtdate
carriedFrom.confirmedBystring
enrichment enrichment
FieldTypeValues
enrichment.sourcestring
enrichment.externalIdstring
enrichment.fetchedAtdate
pendingImages pendingImages
FieldTypeValues
pendingImages[].colorstring
pendingImages[].urlstring
pendingImagesLeaseUntil pendingImagesLeaseUntil
FieldTypeValues
pendingImagesLeaseUntildate
imageFailures imageFailures
FieldTypeValues
imageFailures[].colorstring
imageFailures[].urlstring
imageFailures[].reasonstring
imageFailures[].atdate
epr epr
FieldTypeValues
epr.categoryOverridesobject
epr.categoryOverrides.$*string

Questions or a missing endpoint? Get in touch.