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.

Import a purchase order: POST /api/v1/purchase-orders/import
Check what still blocks publishing: GET /api/v1/purchase-orders/{id}
Fill the gaps on a product: PATCH /api/v1/products/{id}
Publish it: POST /api/v1/products/{id}/publish
List the passports: GET /api/v1/passports
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.

Scope	Grants
`product:read`	Products: Read
`product:create`	Products: Create
`product:update`	Products: Update
`product:delete`	Products: Delete
`product:publish`	Products: Publish
`purchaseOrder:read`	Purchase Orders: Read
`purchaseOrder:create`	Purchase Orders: Create
`purchaseOrder:delete`	Purchase 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.

Code	Status	When
`unauthorized`	401	Missing, malformed or unknown API key
`key_revoked`	401	The key was revoked in Settings
`key_expired`	401	The key passed its expiry date
`api_access_disabled`	403	API access is not enabled for the organization
`subscription_required`	403	The organization has no active subscription
`insufficient_scope`	403	The key lacks the scope the endpoint requires
`not_found`	404	No such resource in this organization
`invalid_json`	400	The request body is not valid JSON
`payload_too_large`	413	The request body exceeds the endpoint cap
`validation_failed`	422	A field failed validation
`invalid_query`	422	A query parameter failed validation
`invalid_cursor`	422	The cursor is malformed
`invalid_rows`	422	Import rows failed validation; details carry the row index
`style_spans_pos`	422	One style appears under two PO numbers in one import
`publish_blocked`	422	The publish gate found missing data; details list it
`publish_locked`	409	Another publish holds the lock; retry shortly
`product_published`	409	Deleting a live product needs ?force=true
`po_has_published_products`	409	A PO with live passports cannot be deleted
`rate_limited`	429	Budget exhausted; honour Retry-After
`internal_error`	500	Unexpected 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 per size that has a GTIN. GET /products/{id}/readiness reports exactly what still blocks it. A product needs:

a style number, a garment 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. Published passports count toward your subscription 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

8 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.

Parameter	In	Type	Description
`q`	query	string	Search style number or garment name
`status`	query	draft \| published \| archived
`purchaseOrderId`	query	string
`updatedSince`	query	string (date-time)	Only products updated at or after this ISO 8601 timestamp (incremental sync)
`cursor`	query	string	Opaque cursor from the previous page meta.nextCursor
`limit`	query	integer	Page 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",
      "ean": "5712952970021",
      "status": "draft",
      "mode": "full",
      "pendingChanges": false,
      "purchaseOrderId": "66d0a1b2c3d4e5f6a7b8c9e1",
      "variantCount": 4,
      "totalQuantity": 480,
      "passportCount": 0,
      "certComplete": true,
      "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.

Parameter	In	Type	Description
`id` required	path	string	The resource id
`include`	query	snapshot	Add 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.

Parameter	In	Type	Description
`id` required	path	string	The 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.

Parameter	In	Type	Description
`id` required	path	string	The resource id
`force`	query	boolean	Required 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.

Parameter	In	Type	Description
`id` required	path	string	The 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": []
  }
}

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. Every newly minted passport counts toward the subscription exactly as in the app.

Parameter	In	Type	Description
`id` required	path	string	The 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.

Parameter	In	Type	Description
`id` required	path	string	The 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.

Parameter	In	Type	Description
`q`	query	string	Search PO number or supplier
`updatedSince`	query	string (date-time)	Only purchase orders updated at or after this ISO 8601 timestamp (incremental sync)
`cursor`	query	string	Opaque cursor from the previous page meta.nextCursor
`limit`	query	integer	Page 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","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","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",
      "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",
      "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,
      "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.

Parameter	In	Type	Description
`id` required	path	string	The 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,
        "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.

Parameter	In	Type	Description
`id` required	path	string	The 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.

Parameter	In	Type	Description
`id` required	path	string	The 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

2 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.

Parameter	In	Type	Description
`id` required	path	string	The 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 garments published in a date range

Products whose latest publish falls inside [from, to] (UTC day bounds). At most 5,000 products per range; narrow the dates otherwise.

Parameter	In	Type	Description
`from` required	query	string (date)
`to` required	query	string (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"
    },
    "rowCount": 0,
    "garments": [],
    "fibres": []
  }
}

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.

Parameter	In	Type	Description
`productId`	query	string
`purchaseOrderId`	query	string
`gtin`	query	string	8 to 14 digits; padded and unpadded forms match
`scope`	query	size \| color	size = one passport per size (default kind), color = the optional per-colorway style passport
`includeRetired`	query	boolean
`publishedSince`	query	string (date-time)	Only products published at or after this ISO 8601 timestamp (incremental sync)
`cursor`	query	string	Opaque cursor from the previous page meta.nextCursor
`limit`	query	integer	Page 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

Parameter	In	Type	Description
`dppId` required	path	string	The 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.

Parameter	In	Type	Description
`dppId` required	path	string	The passport id (the /21/ segment of the passport URL)
`format`	query	png \| svg
`size`	query	integer	Pixels (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

Field	Type	Values
`mode`	string	lightfull

Basics basics

Field	Type	Values
`basics.styleNumber`	string
`basics.garmentName`	string
`basics.color`	string
`basics.ean`	string
`basics.hsCode`	string
`basics.countryOfOrigin`	string
`basics.dppNumber`	string
`basics.poQuantity`	number
`basics.images[].name`	string
`basics.images[].url`	string
`basics.images[].sourceUrl`	string
`basics.sizeGuide.name`	string
`basics.sizeGuide.url`	string
`basics.sizeGuide.sourceUrl`	string
`basics.sizeGuideId`	string

Identity identity

Field	Type	Values
`identity.eoSupplierId`	string
`identity.eoName`	string
`identity.eoNameLocal`	string
`identity.eoCountry`	string
`identity.eoUid`	string
`identity.eoPostal`	string
`identity.eoAddress`	string
`identity.eoEmail`	string
`identity.eoWeb`	string
`identity.eoCerts[].name`	string
`identity.eoCerts[].type`	string	default Scope
`identity.eoCerts[].claim`	string
`identity.eoCerts[].fiber`	string
`identity.eoCerts[].issue`	date
`identity.eoCerts[].expiry`	date
`identity.eoCerts[].number`	string
`identity.eoCerts[].body`	string
`identity.eoCerts[].audit`	date
`identity.eoCerts[].files[].name`	string
`identity.eoCerts[].files[].url`	string
`identity.eoCerts[].files[].sourceUrl`	string
`identity.eoCerts[].itemTypes`	array of string
`identity.eoCerts[].certificateId`	string
`identity.assemblyFactory.supplierId`	string
`identity.assemblyFactory.name`	string
`identity.assemblyFactory.nameLocal`	string
`identity.assemblyFactory.country`	string
`identity.assemblyFactory.postal`	string
`identity.assemblyFactory.addr`	string
`identity.assemblyFactory.certs[].name`	string
`identity.assemblyFactory.certs[].type`	string	default Scope
`identity.assemblyFactory.certs[].claim`	string
`identity.assemblyFactory.certs[].fiber`	string
`identity.assemblyFactory.certs[].issue`	date
`identity.assemblyFactory.certs[].expiry`	date
`identity.assemblyFactory.certs[].number`	string
`identity.assemblyFactory.certs[].body`	string
`identity.assemblyFactory.certs[].audit`	date
`identity.assemblyFactory.certs[].files[].name`	string
`identity.assemblyFactory.certs[].files[].url`	string
`identity.assemblyFactory.certs[].files[].sourceUrl`	string
`identity.assemblyFactory.certs[].itemTypes`	array of string
`identity.assemblyFactory.certs[].certificateId`	string
`identity.assemblyFactory.disclosure`	string	suppliercountry
`identity.washPlant.supplierId`	string
`identity.washPlant.name`	string
`identity.washPlant.nameLocal`	string
`identity.washPlant.country`	string
`identity.washPlant.postal`	string
`identity.washPlant.addr`	string
`identity.washPlant.certs[].name`	string
`identity.washPlant.certs[].type`	string	default Scope
`identity.washPlant.certs[].claim`	string
`identity.washPlant.certs[].fiber`	string
`identity.washPlant.certs[].issue`	date
`identity.washPlant.certs[].expiry`	date
`identity.washPlant.certs[].number`	string
`identity.washPlant.certs[].body`	string
`identity.washPlant.certs[].audit`	date
`identity.washPlant.certs[].files[].name`	string
`identity.washPlant.certs[].files[].url`	string
`identity.washPlant.certs[].files[].sourceUrl`	string
`identity.washPlant.certs[].itemTypes`	array of string
`identity.washPlant.certs[].certificateId`	string
`identity.washPlant.disclosure`	string	suppliercountry

Composition composition

Field	Type	Values
`composition.garmentType`	string	wovencircular_knitknitleatheraccessory
`composition.wovenLayers[].layerType`	string
`composition.wovenLayers[].layerCustomName`	string
`composition.wovenLayers[].fabricKind`	string	wovencircular_knit
`composition.wovenLayers[].gsm`	number
`composition.wovenLayers[].width`	number
`composition.wovenLayers[].consumption`	number
`composition.wovenLayers[].weaveType`	string
`composition.wovenLayers[].dyes`	array of string
`composition.wovenLayers[].prints`	array of string
`composition.wovenLayers[].fabricConstruction`	string
`composition.wovenLayers[].componentWeightG`	number
`composition.wovenLayers[].fibers[].fiberType`	string
`composition.wovenLayers[].fibers[].percentage`	number
`composition.wovenLayers[].fibers[].country`	string
`composition.wovenLayers[].fibers[].recycledType`	string
`composition.wovenLayers[].fibers[].nylonType`	string
`composition.wovenLayers[].fibers[].fiberWeightG`	number
`composition.wovenLayers[].fibers[].matched`	boolean
`composition.wovenLayers[].fibers[].raw`	string
`composition.wovenLayers[].supply.t1.supplierId`	string
`composition.wovenLayers[].supply.t1.name`	string
`composition.wovenLayers[].supply.t1.nameLocal`	string
`composition.wovenLayers[].supply.t1.country`	string
`composition.wovenLayers[].supply.t1.postal`	string
`composition.wovenLayers[].supply.t1.addr`	string
`composition.wovenLayers[].supply.t1.certs[].name`	string
`composition.wovenLayers[].supply.t1.certs[].type`	string	default Scope
`composition.wovenLayers[].supply.t1.certs[].claim`	string
`composition.wovenLayers[].supply.t1.certs[].fiber`	string
`composition.wovenLayers[].supply.t1.certs[].issue`	date
`composition.wovenLayers[].supply.t1.certs[].expiry`	date
`composition.wovenLayers[].supply.t1.certs[].number`	string
`composition.wovenLayers[].supply.t1.certs[].body`	string
`composition.wovenLayers[].supply.t1.certs[].audit`	date
`composition.wovenLayers[].supply.t1.certs[].files[].name`	string
`composition.wovenLayers[].supply.t1.certs[].files[].url`	string
`composition.wovenLayers[].supply.t1.certs[].files[].sourceUrl`	string
`composition.wovenLayers[].supply.t1.certs[].itemTypes`	array of string
`composition.wovenLayers[].supply.t1.certs[].certificateId`	string
`composition.wovenLayers[].supply.t1.disclosure`	string	suppliercountry
`composition.wovenLayers[].supply.t2.supplierId`	string
`composition.wovenLayers[].supply.t2.name`	string
`composition.wovenLayers[].supply.t2.nameLocal`	string
`composition.wovenLayers[].supply.t2.country`	string
`composition.wovenLayers[].supply.t2.postal`	string
`composition.wovenLayers[].supply.t2.addr`	string
`composition.wovenLayers[].supply.t2.certs[].name`	string
`composition.wovenLayers[].supply.t2.certs[].type`	string	default Scope
`composition.wovenLayers[].supply.t2.certs[].claim`	string
`composition.wovenLayers[].supply.t2.certs[].fiber`	string
`composition.wovenLayers[].supply.t2.certs[].issue`	date
`composition.wovenLayers[].supply.t2.certs[].expiry`	date
`composition.wovenLayers[].supply.t2.certs[].number`	string
`composition.wovenLayers[].supply.t2.certs[].body`	string
`composition.wovenLayers[].supply.t2.certs[].audit`	date
`composition.wovenLayers[].supply.t2.certs[].files[].name`	string
`composition.wovenLayers[].supply.t2.certs[].files[].url`	string
`composition.wovenLayers[].supply.t2.certs[].files[].sourceUrl`	string
`composition.wovenLayers[].supply.t2.certs[].itemTypes`	array of string
`composition.wovenLayers[].supply.t2.certs[].certificateId`	string
`composition.wovenLayers[].supply.t2.disclosure`	string	suppliercountry
`composition.wovenLayers[].supply.t2b.supplierId`	string
`composition.wovenLayers[].supply.t2b.name`	string
`composition.wovenLayers[].supply.t2b.nameLocal`	string
`composition.wovenLayers[].supply.t2b.country`	string
`composition.wovenLayers[].supply.t2b.postal`	string
`composition.wovenLayers[].supply.t2b.addr`	string
`composition.wovenLayers[].supply.t2b.certs[].name`	string
`composition.wovenLayers[].supply.t2b.certs[].type`	string	default Scope
`composition.wovenLayers[].supply.t2b.certs[].claim`	string
`composition.wovenLayers[].supply.t2b.certs[].fiber`	string
`composition.wovenLayers[].supply.t2b.certs[].issue`	date
`composition.wovenLayers[].supply.t2b.certs[].expiry`	date
`composition.wovenLayers[].supply.t2b.certs[].number`	string
`composition.wovenLayers[].supply.t2b.certs[].body`	string
`composition.wovenLayers[].supply.t2b.certs[].audit`	date
`composition.wovenLayers[].supply.t2b.certs[].files[].name`	string
`composition.wovenLayers[].supply.t2b.certs[].files[].url`	string
`composition.wovenLayers[].supply.t2b.certs[].files[].sourceUrl`	string
`composition.wovenLayers[].supply.t2b.certs[].itemTypes`	array of string
`composition.wovenLayers[].supply.t2b.certs[].certificateId`	string
`composition.wovenLayers[].supply.t2b.disclosure`	string	suppliercountry
`composition.wovenLayers[].supply.t3.supplierId`	string
`composition.wovenLayers[].supply.t3.name`	string
`composition.wovenLayers[].supply.t3.nameLocal`	string
`composition.wovenLayers[].supply.t3.country`	string
`composition.wovenLayers[].supply.t3.postal`	string
`composition.wovenLayers[].supply.t3.addr`	string
`composition.wovenLayers[].supply.t3.certs[].name`	string
`composition.wovenLayers[].supply.t3.certs[].type`	string	default Scope
`composition.wovenLayers[].supply.t3.certs[].claim`	string
`composition.wovenLayers[].supply.t3.certs[].fiber`	string
`composition.wovenLayers[].supply.t3.certs[].issue`	date
`composition.wovenLayers[].supply.t3.certs[].expiry`	date
`composition.wovenLayers[].supply.t3.certs[].number`	string
`composition.wovenLayers[].supply.t3.certs[].body`	string
`composition.wovenLayers[].supply.t3.certs[].audit`	date
`composition.wovenLayers[].supply.t3.certs[].files[].name`	string
`composition.wovenLayers[].supply.t3.certs[].files[].url`	string
`composition.wovenLayers[].supply.t3.certs[].files[].sourceUrl`	string
`composition.wovenLayers[].supply.t3.certs[].itemTypes`	array of string
`composition.wovenLayers[].supply.t3.certs[].certificateId`	string
`composition.wovenLayers[].supply.t3.disclosure`	string	suppliercountry
`composition.wovenLayers[].supply.t4.supplierId`	string
`composition.wovenLayers[].supply.t4.name`	string
`composition.wovenLayers[].supply.t4.nameLocal`	string
`composition.wovenLayers[].supply.t4.country`	string
`composition.wovenLayers[].supply.t4.postal`	string
`composition.wovenLayers[].supply.t4.addr`	string
`composition.wovenLayers[].supply.t4.certs[].name`	string
`composition.wovenLayers[].supply.t4.certs[].type`	string	default Scope
`composition.wovenLayers[].supply.t4.certs[].claim`	string
`composition.wovenLayers[].supply.t4.certs[].fiber`	string
`composition.wovenLayers[].supply.t4.certs[].issue`	date
`composition.wovenLayers[].supply.t4.certs[].expiry`	date
`composition.wovenLayers[].supply.t4.certs[].number`	string
`composition.wovenLayers[].supply.t4.certs[].body`	string
`composition.wovenLayers[].supply.t4.certs[].audit`	date
`composition.wovenLayers[].supply.t4.certs[].files[].name`	string
`composition.wovenLayers[].supply.t4.certs[].files[].url`	string
`composition.wovenLayers[].supply.t4.certs[].files[].sourceUrl`	string
`composition.wovenLayers[].supply.t4.certs[].itemTypes`	array of string
`composition.wovenLayers[].supply.t4.certs[].certificateId`	string
`composition.wovenLayers[].supply.t4.disclosure`	string	suppliercountry
`composition.wovenLayers[].sourceComponentId`	string
`composition.wovenLayers[].snapshot.sourceId`	string
`composition.wovenLayers[].snapshot.sourceModel`	string
`composition.wovenLayers[].snapshot.sourceLabel`	string
`composition.wovenLayers[].snapshot.snapshotAt`	date
`composition.wovenLayers[].snapshot.sourceUpdatedAt`	date
`composition.knitWeight`	number
`composition.knitStructure`	string
`composition.knitBlocks[].yarnCount`	string
`composition.knitBlocks[].knitStructure`	string
`composition.knitBlocks[].dyes`	array of string
`composition.knitBlocks[].prints`	array of string
`composition.knitBlocks[].share`	number
`composition.knitBlocks[].fibers[].fiberType`	string
`composition.knitBlocks[].fibers[].percentage`	number
`composition.knitBlocks[].fibers[].country`	string
`composition.knitBlocks[].fibers[].recycledType`	string
`composition.knitBlocks[].fibers[].nylonType`	string
`composition.knitBlocks[].fibers[].fiberWeightG`	number
`composition.knitBlocks[].fibers[].matched`	boolean
`composition.knitBlocks[].fibers[].raw`	string
`composition.knitBlocks[].supply.t1.supplierId`	string
`composition.knitBlocks[].supply.t1.name`	string
`composition.knitBlocks[].supply.t1.nameLocal`	string
`composition.knitBlocks[].supply.t1.country`	string
`composition.knitBlocks[].supply.t1.postal`	string
`composition.knitBlocks[].supply.t1.addr`	string
`composition.knitBlocks[].supply.t1.certs[].name`	string
`composition.knitBlocks[].supply.t1.certs[].type`	string	default Scope
`composition.knitBlocks[].supply.t1.certs[].claim`	string
`composition.knitBlocks[].supply.t1.certs[].fiber`	string
`composition.knitBlocks[].supply.t1.certs[].issue`	date
`composition.knitBlocks[].supply.t1.certs[].expiry`	date
`composition.knitBlocks[].supply.t1.certs[].number`	string
`composition.knitBlocks[].supply.t1.certs[].body`	string
`composition.knitBlocks[].supply.t1.certs[].audit`	date
`composition.knitBlocks[].supply.t1.certs[].files[].name`	string
`composition.knitBlocks[].supply.t1.certs[].files[].url`	string
`composition.knitBlocks[].supply.t1.certs[].files[].sourceUrl`	string
`composition.knitBlocks[].supply.t1.certs[].itemTypes`	array of string
`composition.knitBlocks[].supply.t1.certs[].certificateId`	string
`composition.knitBlocks[].supply.t1.disclosure`	string	suppliercountry
`composition.knitBlocks[].supply.t2.supplierId`	string
`composition.knitBlocks[].supply.t2.name`	string
`composition.knitBlocks[].supply.t2.nameLocal`	string
`composition.knitBlocks[].supply.t2.country`	string
`composition.knitBlocks[].supply.t2.postal`	string
`composition.knitBlocks[].supply.t2.addr`	string
`composition.knitBlocks[].supply.t2.certs[].name`	string
`composition.knitBlocks[].supply.t2.certs[].type`	string	default Scope
`composition.knitBlocks[].supply.t2.certs[].claim`	string
`composition.knitBlocks[].supply.t2.certs[].fiber`	string
`composition.knitBlocks[].supply.t2.certs[].issue`	date
`composition.knitBlocks[].supply.t2.certs[].expiry`	date
`composition.knitBlocks[].supply.t2.certs[].number`	string
`composition.knitBlocks[].supply.t2.certs[].body`	string
`composition.knitBlocks[].supply.t2.certs[].audit`	date
`composition.knitBlocks[].supply.t2.certs[].files[].name`	string
`composition.knitBlocks[].supply.t2.certs[].files[].url`	string
`composition.knitBlocks[].supply.t2.certs[].files[].sourceUrl`	string
`composition.knitBlocks[].supply.t2.certs[].itemTypes`	array of string
`composition.knitBlocks[].supply.t2.certs[].certificateId`	string
`composition.knitBlocks[].supply.t2.disclosure`	string	suppliercountry
`composition.knitBlocks[].supply.t2b.supplierId`	string
`composition.knitBlocks[].supply.t2b.name`	string
`composition.knitBlocks[].supply.t2b.nameLocal`	string
`composition.knitBlocks[].supply.t2b.country`	string
`composition.knitBlocks[].supply.t2b.postal`	string
`composition.knitBlocks[].supply.t2b.addr`	string
`composition.knitBlocks[].supply.t2b.certs[].name`	string
`composition.knitBlocks[].supply.t2b.certs[].type`	string	default Scope
`composition.knitBlocks[].supply.t2b.certs[].claim`	string
`composition.knitBlocks[].supply.t2b.certs[].fiber`	string
`composition.knitBlocks[].supply.t2b.certs[].issue`	date
`composition.knitBlocks[].supply.t2b.certs[].expiry`	date
`composition.knitBlocks[].supply.t2b.certs[].number`	string
`composition.knitBlocks[].supply.t2b.certs[].body`	string
`composition.knitBlocks[].supply.t2b.certs[].audit`	date
`composition.knitBlocks[].supply.t2b.certs[].files[].name`	string
`composition.knitBlocks[].supply.t2b.certs[].files[].url`	string
`composition.knitBlocks[].supply.t2b.certs[].files[].sourceUrl`	string
`composition.knitBlocks[].supply.t2b.certs[].itemTypes`	array of string
`composition.knitBlocks[].supply.t2b.certs[].certificateId`	string
`composition.knitBlocks[].supply.t2b.disclosure`	string	suppliercountry
`composition.knitBlocks[].supply.t3.supplierId`	string
`composition.knitBlocks[].supply.t3.name`	string
`composition.knitBlocks[].supply.t3.nameLocal`	string
`composition.knitBlocks[].supply.t3.country`	string
`composition.knitBlocks[].supply.t3.postal`	string
`composition.knitBlocks[].supply.t3.addr`	string
`composition.knitBlocks[].supply.t3.certs[].name`	string
`composition.knitBlocks[].supply.t3.certs[].type`	string	default Scope
`composition.knitBlocks[].supply.t3.certs[].claim`	string
`composition.knitBlocks[].supply.t3.certs[].fiber`	string
`composition.knitBlocks[].supply.t3.certs[].issue`	date
`composition.knitBlocks[].supply.t3.certs[].expiry`	date
`composition.knitBlocks[].supply.t3.certs[].number`	string
`composition.knitBlocks[].supply.t3.certs[].body`	string
`composition.knitBlocks[].supply.t3.certs[].audit`	date
`composition.knitBlocks[].supply.t3.certs[].files[].name`	string
`composition.knitBlocks[].supply.t3.certs[].files[].url`	string
`composition.knitBlocks[].supply.t3.certs[].files[].sourceUrl`	string
`composition.knitBlocks[].supply.t3.certs[].itemTypes`	array of string
`composition.knitBlocks[].supply.t3.certs[].certificateId`	string
`composition.knitBlocks[].supply.t3.disclosure`	string	suppliercountry
`composition.knitBlocks[].supply.t4.supplierId`	string
`composition.knitBlocks[].supply.t4.name`	string
`composition.knitBlocks[].supply.t4.nameLocal`	string
`composition.knitBlocks[].supply.t4.country`	string
`composition.knitBlocks[].supply.t4.postal`	string
`composition.knitBlocks[].supply.t4.addr`	string
`composition.knitBlocks[].supply.t4.certs[].name`	string
`composition.knitBlocks[].supply.t4.certs[].type`	string	default Scope
`composition.knitBlocks[].supply.t4.certs[].claim`	string
`composition.knitBlocks[].supply.t4.certs[].fiber`	string
`composition.knitBlocks[].supply.t4.certs[].issue`	date
`composition.knitBlocks[].supply.t4.certs[].expiry`	date
`composition.knitBlocks[].supply.t4.certs[].number`	string
`composition.knitBlocks[].supply.t4.certs[].body`	string
`composition.knitBlocks[].supply.t4.certs[].audit`	date
`composition.knitBlocks[].supply.t4.certs[].files[].name`	string
`composition.knitBlocks[].supply.t4.certs[].files[].url`	string
`composition.knitBlocks[].supply.t4.certs[].files[].sourceUrl`	string
`composition.knitBlocks[].supply.t4.certs[].itemTypes`	array of string
`composition.knitBlocks[].supply.t4.certs[].certificateId`	string
`composition.knitBlocks[].supply.t4.disclosure`	string	suppliercountry
`composition.knitBlocks[].sourceComponentId`	string
`composition.knitBlocks[].snapshot.sourceId`	string
`composition.knitBlocks[].snapshot.sourceModel`	string
`composition.knitBlocks[].snapshot.sourceLabel`	string
`composition.knitBlocks[].snapshot.snapshotAt`	date
`composition.knitBlocks[].snapshot.sourceUpdatedAt`	date
`composition.hasSequins`	boolean
`composition.fiberCerts[].name`	string
`composition.fiberCerts[].type`	string	default Scope
`composition.fiberCerts[].claim`	string
`composition.fiberCerts[].fiber`	string
`composition.fiberCerts[].issue`	date
`composition.fiberCerts[].expiry`	date
`composition.fiberCerts[].number`	string
`composition.fiberCerts[].body`	string
`composition.fiberCerts[].audit`	date
`composition.fiberCerts[].files[].name`	string
`composition.fiberCerts[].files[].url`	string
`composition.fiberCerts[].files[].sourceUrl`	string
`composition.fiberCerts[].itemTypes`	array of string
`composition.fiberCerts[].certificateId`	string

Trims trims

Field	Type	Values
`trims.thread.material`	string
`trims.thread.weightG`	number
`trims.thread.country`	string
`trims.thread.supplierSnapshot.supplierId`	string
`trims.thread.supplierSnapshot.name`	string
`trims.thread.supplierSnapshot.nameLocal`	string
`trims.thread.supplierSnapshot.country`	string
`trims.thread.supplierSnapshot.postal`	string
`trims.thread.supplierSnapshot.addr`	string
`trims.thread.supplierSnapshot.certs[].name`	string
`trims.thread.supplierSnapshot.certs[].type`	string	default Scope
`trims.thread.supplierSnapshot.certs[].claim`	string
`trims.thread.supplierSnapshot.certs[].fiber`	string
`trims.thread.supplierSnapshot.certs[].issue`	date
`trims.thread.supplierSnapshot.certs[].expiry`	date
`trims.thread.supplierSnapshot.certs[].number`	string
`trims.thread.supplierSnapshot.certs[].body`	string
`trims.thread.supplierSnapshot.certs[].audit`	date
`trims.thread.supplierSnapshot.certs[].files[].name`	string
`trims.thread.supplierSnapshot.certs[].files[].url`	string
`trims.thread.supplierSnapshot.certs[].files[].sourceUrl`	string
`trims.thread.supplierSnapshot.certs[].itemTypes`	array of string
`trims.thread.supplierSnapshot.certs[].certificateId`	string
`trims.thread.supplierSnapshot.disclosure`	string	suppliercountry
`trims.buttons[].material`	string
`trims.buttons[].weightG`	number
`trims.buttons[].qty`	number
`trims.buttons[].country`	string
`trims.buttons[].supplierSnapshot.supplierId`	string
`trims.buttons[].supplierSnapshot.name`	string
`trims.buttons[].supplierSnapshot.nameLocal`	string
`trims.buttons[].supplierSnapshot.country`	string
`trims.buttons[].supplierSnapshot.postal`	string
`trims.buttons[].supplierSnapshot.addr`	string
`trims.buttons[].supplierSnapshot.certs[].name`	string
`trims.buttons[].supplierSnapshot.certs[].type`	string	default Scope
`trims.buttons[].supplierSnapshot.certs[].claim`	string
`trims.buttons[].supplierSnapshot.certs[].fiber`	string
`trims.buttons[].supplierSnapshot.certs[].issue`	date
`trims.buttons[].supplierSnapshot.certs[].expiry`	date
`trims.buttons[].supplierSnapshot.certs[].number`	string
`trims.buttons[].supplierSnapshot.certs[].body`	string
`trims.buttons[].supplierSnapshot.certs[].audit`	date
`trims.buttons[].supplierSnapshot.certs[].files[].name`	string
`trims.buttons[].supplierSnapshot.certs[].files[].url`	string
`trims.buttons[].supplierSnapshot.certs[].files[].sourceUrl`	string
`trims.buttons[].supplierSnapshot.certs[].itemTypes`	array of string
`trims.buttons[].supplierSnapshot.certs[].certificateId`	string
`trims.buttons[].supplierSnapshot.disclosure`	string	suppliercountry
`trims.zippers[].type`	string
`trims.zippers[].slider`	string
`trims.zippers[].tape`	string
`trims.zippers[].weightG`	number
`trims.zippers[].qty`	number	default 1
`trims.zippers[].country`	string
`trims.zippers[].supplierSnapshot.supplierId`	string
`trims.zippers[].supplierSnapshot.name`	string
`trims.zippers[].supplierSnapshot.nameLocal`	string
`trims.zippers[].supplierSnapshot.country`	string
`trims.zippers[].supplierSnapshot.postal`	string
`trims.zippers[].supplierSnapshot.addr`	string
`trims.zippers[].supplierSnapshot.certs[].name`	string
`trims.zippers[].supplierSnapshot.certs[].type`	string	default Scope
`trims.zippers[].supplierSnapshot.certs[].claim`	string
`trims.zippers[].supplierSnapshot.certs[].fiber`	string
`trims.zippers[].supplierSnapshot.certs[].issue`	date
`trims.zippers[].supplierSnapshot.certs[].expiry`	date
`trims.zippers[].supplierSnapshot.certs[].number`	string
`trims.zippers[].supplierSnapshot.certs[].body`	string
`trims.zippers[].supplierSnapshot.certs[].audit`	date
`trims.zippers[].supplierSnapshot.certs[].files[].name`	string
`trims.zippers[].supplierSnapshot.certs[].files[].url`	string
`trims.zippers[].supplierSnapshot.certs[].files[].sourceUrl`	string
`trims.zippers[].supplierSnapshot.certs[].itemTypes`	array of string
`trims.zippers[].supplierSnapshot.certs[].certificateId`	string
`trims.zippers[].supplierSnapshot.disclosure`	string	suppliercountry

Packaging packaging

Field	Type	Values
`packaging.components[].type`	string	polybaghangtagsilkpapercardboardsilica
`packaging.components[].status`	string	brand-designatedsupplier-sourcednot-applicable
`packaging.components[].data.material`	string
`packaging.components[].data.weight_g`	number
`packaging.components[].data.recycled_pct`	number
`packaging.components[].data.recycled_source`	string
`packaging.components[].data.certification`	string
`packaging.components[].data.type_number`	string
`packaging.components[].data.doc.name`	string
`packaging.components[].data.doc.url`	string
`packaging.components[].data.doc.sourceUrl`	string
`packaging.components[].data.string_material`	string
`packaging.components[].data.fastener_material`	string
`packaging.components[].data.desiccant_filling`	string
`packaging.components[].data.pouch_material`	string
`packaging.components[].data.units_per_box`	number
`packaging.components[].data.supplier.supplierId`	string
`packaging.components[].data.supplier.name`	string
`packaging.components[].data.supplier.nameLocal`	string
`packaging.components[].data.supplier.country`	string
`packaging.components[].data.supplier.postal`	string
`packaging.components[].data.supplier.addr`	string
`packaging.components[].data.supplier.certs[].name`	string
`packaging.components[].data.supplier.certs[].type`	string	default Scope
`packaging.components[].data.supplier.certs[].claim`	string
`packaging.components[].data.supplier.certs[].fiber`	string
`packaging.components[].data.supplier.certs[].issue`	date
`packaging.components[].data.supplier.certs[].expiry`	date
`packaging.components[].data.supplier.certs[].number`	string
`packaging.components[].data.supplier.certs[].body`	string
`packaging.components[].data.supplier.certs[].audit`	date
`packaging.components[].data.supplier.certs[].files[].name`	string
`packaging.components[].data.supplier.certs[].files[].url`	string
`packaging.components[].data.supplier.certs[].files[].sourceUrl`	string
`packaging.components[].data.supplier.certs[].itemTypes`	array of string
`packaging.components[].data.supplier.certs[].certificateId`	string
`packaging.components[].data.supplier.disclosure`	string	suppliercountry
`packaging.components[].sourceEntryId`	string
`packaging.components[].snapshot.sourceId`	string
`packaging.components[].snapshot.sourceModel`	string
`packaging.components[].snapshot.sourceLabel`	string
`packaging.components[].snapshot.snapshotAt`	date
`packaging.components[].snapshot.sourceUpdatedAt`	date

Wash and Care care

Field	Type	Values
`care.isWashed`	boolean
`care.washes`	array of string
`care.treatments`	array of string
`care.careSymbols`	array of string
`care.careExtras`	array of string
`care.shrinkageSimple`	number

Performance and Impact performance

Field	Type	Values
`performance.spirality`	number
`performance.dimChange`	number
`performance.spiralityPct`	number
`performance.dimChangePct`	number
`performance.appearance.colourChange.grade`	string
`performance.appearance.colourChange.note`	string
`performance.appearance.pilling.grade`	string
`performance.appearance.pilling.note`	string
`performance.appearance.fuzzing.grade`	string
`performance.appearance.fuzzing.note`	string
`performance.appearance.seamAppearance.grade`	string
`performance.appearance.seamAppearance.note`	string
`performance.appearance.nonTextileParts.grade`	string
`performance.appearance.nonTextileParts.note`	string
`performance.co2Value`	number
`performance.co2Scope`	string
`performance.waterValue`	number
`performance.scrapPct`	number

Compliance compliance

Field	Type	Values
`compliance.svhcCompliant`	boolean	default true
`compliance.annex14Compliant`	boolean	default true
`compliance.annex17Compliant`	boolean	default true
`compliance.complianceStatement`	string

Colorways colorways

Field	Type	Values
`colorways[].name`	string
`colorways[].images[].name`	string
`colorways[].images[].url`	string
`colorways[].images[].sourceUrl`	string

Variants (sizes) variants

Field	Type	Values
`variants[].size`	string
`variants[].color`	string
`variants[].ean`	string
`variants[].quantity`	number

Imported Composition importedComposition

Field	Type	Values
`importedComposition`	mixed

Questions or a missing endpoint? Get in touch.