Catalog Endpoints
Preview Endpoint
This page covers ONLY catalog endpoints currently in our Preview version. Check Catalog Endpoints for the complementary list of endpoints available.
Endpoints
Verb | Endpoint | Description |
---|---|---|
POST | /accounts/{accountId}/catalogs/sellers | Create a catalog request to generate a new catalog for Seller account |
 Â
Catalog Creation Request Attributes
Data Type: string
Values: int64
Description: Retailer id(s) carrying the product
sellerId Optional
Data Type: string
Values: -
Description: Seller id(s) from Seller account in respective retailers' catalogs, used to filter down catalog items
 Â
Catalog Status Response Attributes
Data Type: string
Values: int64
Description: ID of the catalog creation status request
type
Data Type: string
Values: RetailMediaCatalogStatus
Description: Type definition of the following attributes structure
status
Data Type: string
Values: enum with possible values: pending
, success
, failure
, expired
, unknown
Description: Status of the catalog creation request
currency
Data Type: string
Values: USD
, EUR
, etc
Description: ISO-4217 currency of the items in the respective catalog
rowCount
Data Type: integer
Values: int32
Description: Number of products contained in the catalog (available when creation reaches success
status
fileSizeBytes
Data Type: integer
Values: int32
Description: Size of catalog, in bytes (available when creation reaches success
status
md5Checksum
Data Type: string
Values: 32-char alpha-numeric strings
Description: MD5 checksum of catalog's content (available when creation reaches success
status
createdAt
Data Type: timestamp
Values: ISO-8601
Description: Timestamp of the creation
message
Data Type: string
Values: -
Description: Optional informative message, for developer consumption
Create a Catalog Request for Seller account
This endpoint creates catalog for a particular Seller account:
https://api.criteo.com/preview/retail-media/accounts/{accountId}/catalogs/sellers
Sample Request
curl --location 'https://api.criteo.com/preview/retail-media/accounts/345656205021392896/catalogs/sellers' \
--header 'Content-Type: application/json' \
--header 'Accept: text/plain' \
--header 'Authorization: Bearer <TOKEN>' \
--data '{
"data": {
"type": "RetailMediaCatalogStatus",
"attributes": {
"sellers": [
{
"retailerId": "123",
"sellerId": "60axxxxxxxxxxxxxxxx"
}
]
}
}
}'
Sample Response
{
"data": {
"type": "RetailMediaCatalogStatus",
"id": "1122850670915847014",
"attributes": {
"status": "pending",
"currency": null,
"rowCount": null,
"fileSizeBytes": null,
"md5Checksum": null,
"createdAt": "2020-04-06T05:11:41.351+00:00",
"message": null
}
}
}
Responses
Response | Description |
---|---|
🔵 200 | Success |
🔴 400 | The indicated catalog is not available for retrieval, wait for a success status |
🔴 403 | API user does not have the authorization to make requests to the account ID. For an authorization request, follow the authorization request steps |
Updated 29 days ago