Catalog products reference

The below outlines the properties possible in a standard sync request as outlined in Syncing products via API.

Request items

Property

Description

Required/optional

Example

catalogId

The catalog you are syncing to.

Required

628dbe95-2ec9-4e07-881d-3e9f92ab2e0b

filters

The filters associated with your product. This may be be category, location, and brand information.

Required

"category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0"

groups

Used for cross and upsell campaigns.

Deprecated for selection groups.
Still required for cross and upsell campaigns

[ "subClassName:Milk", "xSellSubClassName:Coffee", "xSellSubClassName:Tea" "vendor:MilkBrand" ]

gtin

The product code of the product in your system.

Required

23556578965543

inventory

The inventory of the product in your system. If set to 0, product ads will not serve.

If you cannot provide the number, do not send this field and CitrusAd will default inventory to `1

Required.

1

price

The price of the product

Optional

9.90

profit

The profit made on the product

Optional

tags

Used to sync your product name and image that is surfaced in the CitrusAd portal. Follow the structure in the example.

Required

"imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"