| POST | /purchase/{brand}/export | Export Order Data |
|---|
import Foundation
import ServiceStack
public class ExportOrder : Codable
{
/**
* Brand Trigram, e.g. CAR, IWC
*/
// @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
public var brand:String
/**
* POS Legacy
*/
// @ApiMember(Description="POS Legacy", IsRequired=true)
public var posCodes:[String] = []
/**
* Date To
*/
// @ApiMember(Description="Date To")
public var dateTo:Date?
/**
* Date From
*/
// @ApiMember(Description="Date From")
public var dateFrom:Date?
/**
* Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)
*/
// @ApiMember(Description="Possible order statues: B (Backorder), C (Created), D (Draft), I (In transit)N (Pending), P (Shipped), PS (Partially shipped), R (Reserved), X (RP Simulated), Z (Deleted)")
public var status:[String] = []
/**
* Reason Code e.g. Y00, Y06
*/
// @ApiMember(Description="Reason Code e.g. Y00, Y06")
public var reasonCode:[String] = []
/**
* Product Categories
*/
// @ApiMember(Description="Product Categories")
public var productCategories:[ProductCategory] = []
/**
* Final Ship To Pos Codes
*/
// @ApiMember(Description="Final Ship To Pos Codes")
public var finalShipTo:[String] = []
/**
* Export Request ID of the API Consumers
*/
// @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
public var downloadRequestId:String
required public init(){}
}
public class ProductCategory : Codable
{
/**
* Brand Category ID
*/
// @ApiMember(Description="Brand Category ID")
public var brandCategoryId:String
/**
* Grand Category ID
*/
// @ApiMember(Description="Grand Category ID", IsRequired=true)
public var grandCategoryId:String
/**
* Master Category ID
*/
// @ApiMember(Description="Master Category ID")
public var masterCategoryId:String
/**
* Category ID
*/
// @ApiMember(Description="Category ID")
public var categoryId:String
/**
* Sub Category ID
*/
// @ApiMember(Description="Sub Category ID")
public var subCategoryId:String
required public init(){}
}
public class ExportOrderResponse : Codable
{
/**
* Unique Identifier of the Export Request created
*/
// @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
public var asyncTaskId:String
required public init(){}
}
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 /purchase/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
brand: String,
posCodes:
[
String
],
dateTo: 0001-01-01,
dateFrom: 0001-01-01,
status:
[
String
],
reasonCode:
[
String
],
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
finalShipTo:
[
String
],
downloadRequestId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}