Catalogs (1.0)
Download OpenAPI specification:Download
License: Apache 2.0 Terms of Service
This service provides the following resources:
- CRUD catalogs: /catalogs
- Create a full catalog (with products, discounts, product recommandations)
Get items
Get all catalogs
query Parameters
| offset | integer <int64> |
| pageNumber | integer <int32> |
| pageSize | integer <int32> |
| paged | boolean |
| sort.sorted | boolean |
| sort.unsorted | boolean |
| target | string Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
| unpaged | boolean |
Request Body schema: application/json
predicate
object
Responses
Request samples
- Payload
Content type
application/json
{ }Response samples
- 200
Content type
application/json
{- "items": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "descriptions": {
- "fallbackLocale": "string",
- "localizedLongDesc": { },
- "localizedShortDesc": { }
}, - "endDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "originalId": "string",
- "running": true,
- "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "singleUse": true,
- "startDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
- "status": "ENABLED",
- "type": "INTERNAL",
- "updateDate": "2019-08-24T14:15:22Z"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}Create a full catalog
Create a full catalog (with products, discounts, product recommandations)
query Parameters
| reason | string Default: "resource creation thru REST Api" reason |
Request Body schema: application/jsonrequired
fullCatalog
object (AbstractCatalog) | |
Array of objects (CatalogItem) | |
| locale | string Country code in ISO 3166-2 format |
Array of objects (Product) | |
Array of objects (CatalogItem) | |
| storeId | string Store identifier |
Responses
Request samples
- Payload
Content type
application/json
{- "catalog": {
- "createDate": "2019-08-24T14:15:22Z",
- "customerId": "string",
- "dbVersion": 0,
- "descriptions": {
- "fallbackLocale": "string",
- "localizedLongDesc": { },
- "localizedShortDesc": { }
}, - "endDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
- "id": "string",
- "lastUpdateReason": "string",
- "modelVersion": "string",
- "name": "string",
- "originalId": "string",
- "running": true,
- "salesMode": "BILLING_PLAN",
- "sellingStores": [
- "string"
], - "singleUse": true,
- "startDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
- "status": "ENABLED",
- "type": "INTERNAL",
- "updateDate": "2019-08-24T14:15:22Z"
}, - "discounts": [
- {
- "catalogId": "string",
- "customerId": "string"
}
], - "locale": "FR",
- "products": [
- {
- "catalogId": "string",
- "customerId": "string",
- "parentId": "string"
}
], - "recommendations": [
- {
- "catalogId": "string",
- "customerId": "string"
}
], - "storeId": "string"
}Response samples
- 201
Content type
application/json
{ }Get recap quantities for a given field
Get a list of recap entries
query Parameters
| offset | integer <int64> |
| pageNumber | integer <int32> |
| pageSize | integer <int32> |
| paged | boolean |
| sort.sorted | boolean |
| sort.unsorted | boolean |
| target required | string Return selected fields only (multiple occurrences allowed for selecting multiple fields) |
| unpaged | boolean |
Request Body schema: application/json
predicate
object
Responses
Request samples
- Payload
Content type
application/json
{ }Response samples
- 200
Content type
application/json
{- "items": [
- {
- "count": 0,
- "targetValue": "string"
}
], - "last": true,
- "number": 0,
- "size": 0,
- "totalItems": 0,
- "totalPages": 0
}