Adding Sellers
Sellers are not added with the API. Instead, they are automatically added from the Catalog you provided us. In your catalog, you should provide thesellerName field on the Sellers’ products. Products that don’t have these fields provided will not be advertised.
Removing Sellers
A Seller can be removed by removing its products from the Feed. If you want to stop an advertising a Seller immediately, you can suspend the budgets of its Seller-Campaigns (see “Suspend a budget” section).Getting Sellers
In order to see the list of sellers that were extracted, you can make the following call: Sample responsesellerNameThis corresponds to the
sellerId that was specified in the product catalog you provided.
sellerIdThis
sellerId identifies your seller. It is attributed by our Seller ingestion system.
Parameter | Definition | Type | Required? |
|---|---|---|---|
| Return sellers for the given advertiser Id. Default is to not filter on advertiser |
| No |
| Return sellers for the given campaign Id. Default is to not filter on campaign |
| No |
| Returns only sellers with the given |
| No |
| Return only sellers with a specific status. Possible values:Inactive, ** Active**. |
| No |
| Return sellers with any budget having the given state. Default is to not filter on the budget state. Possible values:Archived, ** Current, Scheduled** |
| No |
| Return sellers with or without products in the catalog. The default is not to filter on products in the catalog. |
| No |
Get Specific Seller
You can also fetch the details of a single Seller using the following request: Sample responseGet a collection of budgets for selected Seller
The following endpoint retrieves a list of budgets for a specific seller, applying any optional filters provided as a query parameters.If no filters are given, return all budgets the user can access, excluding those with an
endDate in the past.When multiple filters are used, only budgets that meet all the specified criteria are returned.
For more information, refer to the budgets endpoint documentation. Sample response
Parameter | Definition | Type | Required? |
|---|---|---|---|
| Filters budgets to those owned by the specified seller. |
| Yes |
| Filters budgets to those funding the specified campaign. |
| No |
| Returns budgets ending after the given date ( |
| No |
| Returns budgets starting on or before the given date ( |
| No |
| Filters budgets by the specified status. Possible values:Archived, ** Current, Scheduled**. |
| No |
| Filters budgets by the specified budget type. |
| No |
| Returns only budgets that currently have a remaining balance. |
| No |
| Returns budgets that have a positive spend amount. |
| No |
Get a collection of campaigns for selected Seller
The following endpoint returns a list of seller campaigns for the specified seller, applying any optional filters provided. If no filters are given, it returns the full collection accessible to the user.When multiple filters are used, only campaigns meeting all filter criteria are included.
For more information, see the seller campaigns endpoint documentation. Sample response
Parameter | Definition | Type | Required? |
|---|---|---|---|
| Limits results to campaigns belonging to the specified seller. |
| Yes |
| Filters campaigns by the budget status. Possible values:Archived, ** Current, Scheduled**. |
| No |
| Filters campaigns linked to the specified campaign ID. |
| No |
| Filters campaigns by the seller’s status. Possible values:Inactive, ** Active**. |
| No |