Pushing Products Via API

Creating a product within a catalog.

Product Syncing Context

Once you have created a catalog, you are able to push or sync products to it.

Minimum Viable Product Context

Below is the minimum required context to sync products. View the reference at the bottom of the page to see all supported fields.

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_goes_here
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"filters": [
"string"
]
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_goes_here" \
-d \
'{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"filters": [
"string"
]
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"filters": [
"string"
],
"groups": [],
"profit": number,
"tags": []
}
]
}
cURL
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"filters": [
"string"
],
"groups": [],
"profit": number,
"tags": []
}
]
}

In an MVP sync, empty or null values for groups, profit and tags can be ignored.

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450 HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
]
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
]
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": 19.99,
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
],
"groups": [],
"profit": null,
"tags": []
}
]
}
cURL
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": 19.99,
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
],
"groups": [],
"profit": null,
"tags": []
}
]
}

In an MVP sync, empty or null values for groups, profit and tags can be ignored.

A Detailed Product Context

Adding in optional fields to sync additional information used by the CitrusAd platform. View the reference below for an explanation of each field.

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_goes_here
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_goes_here" \
-d \
'{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": "number",
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": "number"
}
]
}
cURL
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": "number",
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": "number"
}
]
}

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450 HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"categoryHierarchy": [
"Health&Beauty", "Cosmetics", "Foundation&Powders", "Foundation"
],
"groups": [
"Cosmetics", "Foundations", "Covergirl", "Natural", "Lasting", "Dry Skin", "Beige"
],
"tags": [
"Natural", "Lasting", "Dry Skin", "Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
],
"profit": "1.50"
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"categoryHierarchy": [
"Health&Beauty", "Cosmetics", "Foundation&Powders", "Foundation"
],
"groups": [
"Cosmetics", "Foundations", "Covergirl", "Natural", "Lasting", "Dry Skin", "Beige"
],
"tags": [
"Natural", "Lasting", "Dry Skin", "Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL","Brand:Covergirl","Category:11753","category:Health&Beauty","category:Grocery","Special_Flag:0"
],
"profit": "1.50"
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"gtin": "23556578965543",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 19.99,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"category:Special_Flag:0"
],
"inventory": 50,
"profit": 1.50,
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
]
}
]
}
cURL
{
"catalogProducts": [
{
"gtin": "23556578965543",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 19.99,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"category:Special_Flag:0"
],
"inventory": 50,
"profit": 1.50,
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
]
}
]
}

Syncing Multiple Products

If you are syncing multiple products, you can sequence up to 100 per request.

Below is an example context for syncing 3 products, the teamId will remain the same for all products:

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_goes_here
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=your_teamId_goes_here" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_goes_here" \
-d \
'{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}
cURL
{
"catalogProducts": [
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
},
{
"teamId": "string",
"catalogId": "string",
"gtin": "string",
"inventory": number,
"price": "integer",
"categoryHierarchy": [
"string"
],
"groups": [
"string"
],
"tags": [
"string"
],
"filters": [
"string"
],
"profit": number
}
]
}

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450 HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"categoryHierarchy": [
"Health&Beauty",
"Cosmetics",
"Foundation&Powders",
"Foundation"
],
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"Special_Flag:0"
],
"profit": "1.50"
},
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965738",
"inventory": 26,
"price": "8.50",
"categoryHierarchy": [
"Pantry",
"BreakfastFoods",
"Cereals"
],
"groups": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs",
"Froot Loops",
"Breakfast",
"500g"
],
"tags": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g",
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"profit": "0.50"
},
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965548",
"inventory": 12,
"price": "5.30",
"categoryHierarchy": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
],
"groups": [
"Pantry",
"Snacks",
"Muesli & Snack Bars",
"Nature Valley",
"Muesli Bar",
"Protein Bar"
],
"tags": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Nature Valley Peanut & Chocolate Protein Bar 160g",
"Brand:Nature Valley",
"Category:Pantry",
"category:Snacks",
"category:Muesli & Snack Bars",
"Special_Flag:0"
],
"profit": "0.85"
}
]
}
cURL
curl -iX POST "$BASE_URL/v1/catalog-products?teamId=e8158f9b-bbb9-49fb-93fe-3ad481ca8450" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogProducts": [
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965543",
"inventory": 50,
"price": "19.99",
"categoryHierarchy": [
"Health&Beauty",
"Cosmetics",
"Foundation&Powders",
"Foundation"
],
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"Special_Flag:0"
],
"profit": "1.50"
},
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965738",
"inventory": 26,
"price": "8.50",
"categoryHierarchy": [
"Pantry",
"BreakfastFoods",
"Cereals"
],
"groups": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs",
"Froot Loops",
"Breakfast",
"500g"
],
"tags": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g",
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"profit": "0.50"
},
{
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"gtin": "23556578965548",
"inventory": 12,
"price": "5.30",
"categoryHierarchy": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
],
"groups": [
"Pantry",
"Snacks",
"Muesli & Snack Bars",
"Nature Valley",
"Muesli Bar",
"Protein Bar"
],
"tags": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Nature Valley Peanut & Chocolate Protein Bar 160g",
"Brand:Nature Valley",
"Category:Pantry",
"category:Snacks",
"category:Muesli & Snack Bars",
"Special_Flag:0"
],
"profit": "0.85"
}
]
}'

If successful, you will get the following object returned:

HTTP
cURL
HTTP
HTTP/2 200
{
"catalogProducts": [
{
"gtin": "23556578965543",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 19.99,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"Special_Flag:0"
],
"inventory": 50,
"profit": 1.50,
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
]
},
{
"gtin": "23556578965736688",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 8.50,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs",
"Froot Loops",
"Breakfast",
"500g"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g",
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"inventory": 26,
"profit": 0.50,
"tags": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs"
]
},
{
"gtin": "23556578965548",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 5.30,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Pantry",
"Snacks",
"Muesli & Snack Bars",
"Nature Valley",
"Muesli Bar",
"Protein Bar"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Nature Valley Peanut & Chocolate Protein Bar 160g",
"Brand:Nature Valley",
"Category:Pantry",
"category:Snacks",
"category:Muesli & Snack Bars",
"Special_Flag:0"
],
"inventory": 12,
"profit": 0.85,
"tags": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
]
}
]
}
cURL
{
"catalogProducts": [
{
"gtin": "23556578965543",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 19.99,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Cosmetics",
"Foundations",
"Covergirl",
"Natural",
"Lasting",
"Dry Skin",
"Beige"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL",
"Brand:Covergirl",
"Category:11753",
"category:Health&Beauty",
"category:Grocery",
"Special_Flag:0"
],
"inventory": 50,
"profit": 1.50,
"tags": [
"Natural",
"Lasting",
"Dry Skin",
"Beige"
]
},
{
"gtin": "23556578965736688",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 8.50,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs",
"Froot Loops",
"Breakfast",
"500g"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Kelloggs Froot Loops Breakfast Cereal 500g",
"Brand:Kelloggs",
"category:Pantry",
"category:BreakfastFoods",
"category:Cereals",
"Special_Flag:0"
],
"inventory": 26,
"profit": 0.50,
"tags": [
"Pantry",
"BreakfastFoods",
"Cereals",
"Kelloggs"
]
},
{
"gtin": "23556578965548",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"price": 5.30,
"teamId": "e8158f9b-bbb9-49fb-93fe-3ad481ca8450",
"groups": [
"Pantry",
"Snacks",
"Muesli & Snack Bars",
"Nature Valley",
"Muesli Bar",
"Protein Bar"
],
"filters": [
"imageurl:https://your.image.host.com/image.jpg",
"name:Nature Valley Peanut & Chocolate Protein Bar 160g",
"Brand:Nature Valley",
"Category:Pantry",
"category:Snacks",
"category:Muesli & Snack Bars",
"Special_Flag:0"
],
"inventory": 12,
"profit": 0.85,
"tags": [
"Pantry",
"Snacks",
"Muesli & Snack Bars"
]
}
]
}

Reference

Relevant Context Fields

String

Description

Required?

teamId

Your teamId

Required

your_api_key_here

Your API key

Required

catalogId

Your catalogId, returned in the object when creating a catalog. Products will be synced to this catalogId

Required

categoryHierarchy

The hierarchy of categories each product belongs to. Can be such as "Health&Beauty", "Cosmetics", "Foundation&Powders", "Foundation"

Optional

gtin

Global Trade Item Number. A globally-unique 14-digit number used to identify trade items.

This can be substituted for any unique code or SKU used in your back end

Required

inventory

The number of available items of this product. If this isn't possible, this can have be sent with a value of 1 to ensure all ads are returned.

Required

groups

Groups specify traits about products that advertisers can use to create campaigns against groups of products, rather than specific products in the product attribute tool. Must be human readable. Could be things like: brand, category, style, demographic, etc.

Optional

tags

A string array of tags associated with the product.

Optional

filters

filters associated with the product, used to match ad generation filters

Required

profit

Typical monetary profit of the product

Optional

For a glossary of all terms in the documentation, see the reference.