Connections

List product types

Lists the marketplace product types.

GET
/v1/connections/{id}/product-types

List product types

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

Returns the product types, one page at a time. Filter by categoryId or search by name with query. Each type has the categoryIds where it applies.

Use it when the marketplace asks for the type, and not only the category: send the type id as productType in Listing requirements.

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

page?integer

Page number, starting at 1. Defaults to 1. A page beyond pagination.totalPages is not an error: it returns empty data.

Range1 <= value <= 9007199254740991
Default1
pageSize?integer

Items per page, from 1 to 100. Defaults to 20.

Range1 <= value <= 100
Default20
categoryId?string

Only product types of this category.

Length1 <= length <= 200
query?string

Only product types whose name matches this text.

Length1 <= length <= 200

Response Body

One page of product types, optionally of one category or matching query. pagination carries the totals.

application/json
  1. response

One page of product types.

data*array<>

The product types of this page, in the order the marketplace gives them.

pagination*

Where this page sits in the whole listing: the totals and whether there are pages before and after it.

curl -X GET "https://example.com/v1/connections/3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01/product-types"
{  "data": [    {      "id": "CELLULAR_PHONE",      "name": "Cellular phone",      "categoryIds": [        "mock-cellphones"      ],      "marketplaceData": {}    }  ],  "pagination": {    "page": 1,    "pageSize": 20,    "totalItems": 57,    "totalPages": 3,    "hasNext": true,    "hasPrev": false  }}