Skip to main content
GET
Get a Single Product Catalog

Authorizations

Authorization
string
header
required

API key en el header Authorization: Basic TU_API_KEY. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración.

Path Parameters

publisher_id
integer
required

Identifier of the Publisher.

catalog_id
integer
required

Identifier of the Product Catalog.

Query Parameters

fields
string

Restrict the fields you wish to retrieve by listing the desired fields formatted as a comma-separated list. Fields like "object", "self", and "id" are always returned.

Response

default - application/json

successful operation

label
string

A text label used to identify this catalog

Maximum string length: 255
Example:

"Default Catalog Name"

source
enum<string>

Source of data used to populate this catalog. Currently only 'database' is supported.

Available options:
database,
api
Example:

"database"

identifier_field
string

CSV column name for the unique identifier field (ie. to uniquely identify a product). Must be defined in the 'field_list' as well.

Maximum string length: 255
Example:

"sku"

title_field
string

CSV column name for the product title. Must be defined in the 'field_list' as well.

Maximum string length: 255
Example:

"title"

description_field
string

CSV column name for the product description. Must be defined in the 'field_list' as well.

Maximum string length: 255
Example:

"description"

seller_id_field
string

CSV column name for the internal seller id (advertiser). Must be defined in the 'field_list' as well.

Maximum string length: 255
Example:

"seller_id"

gtin_field
string

A column name for the GTIN field (ex. a UPC). Must be defined in the 'field_list' as well.

Maximum string length: 255
Example:

"upc"

field_list
string[]

A list of all columns that will be available for submission when adding or uploading catalog items.

Maximum string length: 255
Example:
object
string

A string denoting the current resource being requested or affected.

Example:

"product-catalog"

self
string

The relative URL of the current resource being requested or affected.

Example:

"/v2/publishers/18667/product-db/catalogs/123456"

id
integer

The current resource identifier (ID).

Example:

123456

state
enum<string>

The current state of the catalog. Will be one of: 'SETUP', 'IMPORT', 'ACTIVE'

Available options:
SETUP,
IMPORT,
ACTIVE
Example:

"ACTIVE"

publisher_id
integer

The publisher ID that owns this catalog.

Example:

18667

item_count
integer

The number of items in this catalog.

Example:

212234