Suppliers | Get Catalog Metadata

Getting Supplier Catalog Metadata (Supplier Access)

This document outlines the procedure for retrieving a supplier's shared catalog metadata (categories, brands, tags) from https://<supplier_domain>/public_api/get_supplier_catalog_meta/. It belongs to the supplier_access API section and feeds the category-mapping grid of the requesting account's Supplier import tool.

Supplier Catalog Metadata Retrieval

Endpoint and Method

• Endpoint: https://<supplier_domain>/public_api/get_supplier_catalog_meta/
• Method: POST

Parameters | Payload

• TOKEN (api_key): The supplier_access section API key. How to Create API Credentials.
• username: The grant's API token username (auto-generated at approval).
• password: The grant's API token (40-char hex).
• account: The supplier's account ID (main admin id).

Permissions

• categories[] is returned only when the product category names permission is granted.
• brands[] is returned with the base product data permission.
• tags[] is returned only when the product tags permission is granted.

Each group is omitted entirely when its permission is OFF.

Example Response

{
  "INFO": {"count": 3},
  "OUTPUT": {
    "categories": [{"cid":12,"name":"Bread","parent_id":3}],
    "brands":     [{"bid":3,"name":"Bakery Oy"}],
    "tags":       [{"id":7,"name":"gluten-free"}]
  }
}