Connections

Size chart requirements

Tells whether a category asks for a size chart.

GET
/v1/connections/{id}/size-chart-requirements

Read size chart requirements

  • MockDevelopment only
  • Mercado LivreNot supported
  • MagaluPlanned
  • AmazonPlanned
  • TikTok ShopPlanned
  • ShopeePlanned

Send categoryId and read the support field:

supportWhat it means
unsupportedthe category has no size chart
optionalthe category accepts a size chart
requireda listing without a size chart is refused
curl "$BACKEND_URL/v1/connections/$CONNECTION_ID/size-chart-requirements?categoryId=mock-tshirts" \
  -H "Authorization: Bearer mk_your_api_key"

When there is a chart, measurements lists the measures of each row, with key, label, unit and required (whether every row needs it). With unsupported, the list is empty.

Measures come in the API canonical unit: length in mm and weight in g (unit uses UCUM). The adapter converts from what the marketplace uses, such as cm.

Creating or editing the chart has no common model: use a native operation.

Part of Publish listings. Synchronous read, no Job, as in List categories.

Authorization

api_key
headerAuthorizationBearer <token>

API key (mk_...)

Path Parameters

id*string

Identifier of the resource, as returned by the API.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

categoryId*string

The category to describe.

Length1 <= length <= 200

Response Body

Whether the category takes a size chart (support) and the measurements a row carries.

application/json
  1. response

Whether a category takes a size chart, and what it carries.

categoryId*string

The category these requirements are for.

Length1 <= length <= 200
support*string

unsupported: the category takes no size chart. optional: it takes one. required: a listing without one is refused.

Value in"unsupported""optional""required"
measurements*array<>

The measurements a chart row carries, each with its key, label, UCUM unit and whether every row needs it (required). Empty when support is unsupported.

Itemsitems <= 50
marketplaceData*

The marketplace native value for this item, without personal data. Its shape is the marketplace own and may change without notice: use the canonical fields and keep this for support.

curl -X GET "https://example.com/v1/connections/3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01/size-chart-requirements?categoryId=mock-tshirts"
{  "categoryId": "mock-tshirts",  "support": "required",  "measurements": [    {      "key": "CHEST",      "label": "Chest",      "unit": "mm",      "required": true    },    {      "key": "LENGTH",      "label": "Length",      "unit": "mm",      "required": false    }  ],  "marketplaceData": {}}