Managing Sellers

The seller represents the legal person selling products on your platform. The MPO API enables you to manage the advertisement of your Sellers.

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 the "sellerName" field on the Sellers' products. Products that don't have these fields provided will not be advertised.

🚧

SellerName is case-sensitive. If your seller has different case, it will be considered as a different Seller.

📘

You can use your internal ID of the seller as SellerName.

The catalog can be updated from the Criteo Product Catalog API or directly from Commerce Growth Dashboard.

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:


/marketplace-performance-outcomes/sellers
[{
   "id" : "1",
   "sellerName": "AHepburn",
},{
   "id" : "2",
   "sellerName": "HBogart"
},{
   "id" : "3",
   "sellerName": "NewTech"
}]

A seller is defined by the following:

sellerName
This corresponds to the sellerId that was specified in the product catalog you provided.

sellerId
This SellerId identifies your seller. It is attributed by our Seller ingestion system.

 

Filter ParameterOptionsMeaning
sellerStatusActive, InactiveReturn only sellers with a specific status.
withProductsTrue / FalseReturn sellers with or without products in the catalog. The default is not to filter on products in the catalog.
withBudgetStatusArchived, Current, ScheduledReturn sellers with any budget having the given state. Default is to not filter on the budget state.
sellerNamestringReturns only sellers with the given "sellerName" value.
advertiserIdintegerReturn sellers for the given advertiser Id. Default is to not filter on advertiser
campaignIdintegerReturn sellers for the given campaign Id. Default is to not filter on campaign

🚧

There is an enrichment delay of 24 to 48 hours from when a product is placed in the catalog and becomes available.


Get Specific Seller

You can also fetch the details of a single Seller using the following request:

/marketplace-performance-outcomes/sellers/{sellerId}

Below is the example of the response:

{
  "id": "123456",
  "sellerName": "HBogart"
}

Get 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 of the specified criteria are returned.
For more information, refer to the budgets endpoint documentation.

/marketplace-performance-outcomes/sellers/{sellerId}/budgets

Below is example of the response:

[
  {
    "id": "123456",
    "sellerId": "123456",
    "campaignIds": [
      123532
    ],
    "budgetType": "Daily",
    "amount": 12.0000,
    "startDate": "2021-02-25",
    "endDate": "Never",
    "spend": null,
    "status": "Current",
    "isSuspended": false
  }
]

You can apply the following query parameters to the endpoint to specify filters:

ParameterDefinitionTypeRequired?
campaignIdFilters budgets to those funding the specified campaign.integerNo
endAfterDateReturns budgets ending after the given date (yyyy-MM-DD). If omitted, only budgets still active are returned.stringNo
sellerIdFilters budgets to those owned by the specified seller.stringYes
startBeforeDateReturns budgets starting on or before the given date (yyyy-MM-DD).stringNo
statusFilters budgets by the specified status. Possible values: Archived, Current, Scheduled.stringNo
typeFilters budgets by the specified budget type.stringNo
withBalanceReturns only budgets that currently have a remaining balance.booleanNo
withSpendReturns budgets that have a positive spend amount.booleanNo

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, return 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

/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns

Below is example of the response:

[
  {
    "id": "10624700.225662",
    "sellerId": "10624700",
    "campaignId": 225662,
    "bid": null,
    "suspendedSince": "2021-03-07T23:06:15.17",
    "suspensionReasons": [
      "NoBudgetDefined"
    ]
  }
]

You can apply the following query parameters to the endpoint to specify filters:

ParameterDefinitionTypeRequired?
budgetStatusFilters campaigns by the budget status. Possible values: Archived, Current, Scheduled.stringNo
campaignIdFilters campaigns linked to the specified campaign ID.integerNo
sellerIdLimits results to campaigns belonging to the specified seller.stringYes
sellerStatusFilters campaigns by the seller's status. Possible values: Inactive, Active.stringNo