Connections

Get catalog product

Gets one product from the marketplace catalog.

GET
/v1/connections/{id}/catalog-products/{catalogProductId}
  • MockDevelopment only
  • Mercado LivreNot supported
  • MagaluPlanned
  • AmazonPlanned
  • TikTok ShopPlanned
  • ShopeePlanned

Returns the full product: the attributes the catalog fixes and the variants, each with its identifiers. An id the marketplace does not know gives 404.

The id comes from the search in Search catalog products.

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 connection, 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
catalogProductId*string

Marketplace id of the catalog product, as returned by catalog-products.

Length1 <= length <= 200

Response Body

The catalog product in full: its attributes and variants, besides what the search returns.

application/json
  1. response

A product of the marketplace catalog, in full.

id*string

Marketplace id of the catalog product.

Length1 <= length <= 200
name*string

Name of the catalog product.

Length1 <= length <= 500
brand*|

Name of the brand, or null when the product has none.

categoryId*|

Category the product belongs to, or null when unknown.

productType*|

Product type, or null when the marketplace has none.

identifiers*array<>

Codes that identify the product, such as its GTIN.

Itemsitems <= 30
pictures*array<>

Pictures of the product at the marketplace.

Itemsitems <= 100
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.

attributes*array<>

The attributes the catalog fixes for this product. A listing that points at it inherits them.

Itemsitems <= 200
variants*array<>

The variants of the catalog product.

Itemsitems <= 500
curl -X GET "https://example.com/v1/connections/3f7d8a57-3e44-4c91-bbf1-02d9f4e4e5b0/catalog-products/mock-catalog-phone-1"
{  "id": "mock-catalog-phone-1",  "name": "Acme Phone One",  "brand": "Acme",  "categoryId": "mock-cellphones",  "productType": "CELLULAR_PHONE",  "identifiers": [    {      "type": "GTIN",      "value": "7890000000017"    }  ],  "pictures": [    {      "url": "https://example.com/pictures/acme-phone-one.jpg"    }  ],  "marketplaceData": {},  "attributes": [    {      "key": "MODEL",      "value": {        "type": "text",        "text": "Phone One"      }    }  ],  "variants": [    {      "id": "mock-catalog-phone-1-black",      "identifiers": [        {          "type": "GTIN",          "value": "7890000000017"        }      ],      "attributes": [        {          "key": "COLOR",          "value": {            "type": "enum",            "value": "black"          }        }      ]    }  ]}