| POST | /stock/{brand}/export | Export Stock Data |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| productCategories | body | List<ProductCategory> | No | Product Categories |
| downloadRequestId | body | string | Yes | Export Request ID of the API Consumers |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | form | string | Yes | Brand |
| posCodes | form | List<string> | No | POS Legacy |
| articleCodes | form | List<string> | No | Article Codes |
| includeExtraInfo | form | bool | No | Include Extra Info |
| clusterIds | form | List<string> | No | Cluster Id |
| includeConsignmentNotAuthorizedPOS | form | bool | No | Include Consignment NotAuthorized POS |
| includeRSP | form | bool | No | Include Retail Sales Price in the Output, by default: false |
| dateFrom | form | DateTime? | No | In Stock Since date from |
| dateTo | form | DateTime? | No | In Stock Since date to |
| type | form | string | No | Item type, 'standard' OR 'consigned'. By default, all are coming |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brandCategoryId | form | string | No | Brand Category ID |
| grandCategoryId | form | string | Yes | Grand Category ID |
| masterCategoryId | form | string | No | Master Category ID |
| categoryId | form | string | No | Category ID |
| subCategoryId | form | string | No | Sub Category ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| asyncTaskId | form | Guid | Yes | Unique Identifier of the Export Request created |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /stock/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
downloadRequestId: String,
brand: String,
posCodes:
[
String
],
articleCodes:
[
String
],
includeExtraInfo: False,
clusterIds:
[
String
],
includeConsignmentNotAuthorizedPOS: False,
includeRSP: False,
dateFrom: 0001-01-01,
dateTo: 0001-01-01,
type: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}