Skip to main content
GET
Get a Single Catalog Ad Item

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

id
string
required

Identifier of the Catalog Ad Item (eg client SKU, or whichever other unique identifier used).

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

name
string

A string name for the ad item

Maximum string length: 255
Example:

"Catalog Item with ID"

catalog_id
integer

The id for the catalog

Example:

123456

catalog_item_identifier
string

The unique identifier for the item

Maximum string length: 255
Example:

"123456789"

location
string

The destination URL to which the user will be redirected when they click on the ad item.

Example:

null

tracking_pixel
string

An optional third party tracking pixel served with the ad for monitoring impressions.

Example:

"https://example.com/"

tracking_pixels
object[]

List of tracking pixels. An empty array indicates no tracking pixels are available.

metadata
object

An object containing any number of metadata fields and values.

Example:
object
string

A string denoting the current resource being requested or affected.

Example:

"catalog_ad_item"

self
string

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

Example:

"/v2/ad-items/catalog-item/14456"

id
integer

The identifier for a catalog ad item (eg client SKU, or whichever other unique identifier used)

Example:

14456

created_date
string<date-time>

The date and time when this ad item was created.

Example:

"2023-01-12 15:03:22"

last_modified
string<date-time> | null

The date and time the ad item was last modified.

Example:

"2023-01-19 10:59:22"

deleted
boolean

Whether the ad item has been deleted.

Example:

false