| POST | /warranty/{brand}/export | Export Sell-Out Data | Create a sell-out in a POS you are authorised for |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class ExportSellOut
{
/**
* Brand Trigram, e.g. CAR, IWC
*/
@ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
public String brand = null;
/**
* Pos Legacy IDs / Codes
*/
@ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)
public ArrayList<String> posCodes = null;
/**
* Date To
*/
@ApiMember(Description="Date To")
public Date dateTo = null;
/**
* Date From
*/
@ApiMember(Description="Date From")
public Date dateFrom = null;
/**
* Item Article Codes, both Global and Local
*/
@ApiMember(Description="Item Article Codes, both Global and Local")
public ArrayList<String> articleCodes = null;
/**
* Product Categories
*/
@ApiMember(Description="Product Categories")
public ArrayList<ProductCategory> productCategories = null;
/**
* Sale Representative Email
*/
@ApiMember(Description="Sale Representative Email")
public ArrayList<String> saleRepresentativeEmails = null;
/**
* Sellout Type: 'sellout' for sales, 'return' for returns, null for both
*/
@ApiMember(Description="Sellout Type: 'sellout' for sales, 'return' for returns, null for both")
public String selloutType = null;
/**
* Type: 'consigned' or 'standard', null for both
*/
@ApiMember(Description="Type: 'consigned' or 'standard', null for both")
public String type = null;
/**
* Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)
*/
@ApiMember(Description="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error)")
public ArrayList<Integer> warrantyExtensionStatusIds = null;
/**
* Export Request ID of the API Consumers
*/
@ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
public String downloadRequestId = null;
public String getBrand() { return brand; }
public ExportSellOut setBrand(String value) { this.brand = value; return this; }
public ArrayList<String> getPosCodes() { return posCodes; }
public ExportSellOut setPosCodes(ArrayList<String> value) { this.posCodes = value; return this; }
public Date getDateTo() { return dateTo; }
public ExportSellOut setDateTo(Date value) { this.dateTo = value; return this; }
public Date getDateFrom() { return dateFrom; }
public ExportSellOut setDateFrom(Date value) { this.dateFrom = value; return this; }
public ArrayList<String> getArticleCodes() { return articleCodes; }
public ExportSellOut setArticleCodes(ArrayList<String> value) { this.articleCodes = value; return this; }
public ArrayList<ProductCategory> getProductCategories() { return productCategories; }
public ExportSellOut setProductCategories(ArrayList<ProductCategory> value) { this.productCategories = value; return this; }
public ArrayList<String> getSaleRepresentativeEmails() { return saleRepresentativeEmails; }
public ExportSellOut setSaleRepresentativeEmails(ArrayList<String> value) { this.saleRepresentativeEmails = value; return this; }
public String getSelloutType() { return selloutType; }
public ExportSellOut setSelloutType(String value) { this.selloutType = value; return this; }
public String getType() { return type; }
public ExportSellOut setType(String value) { this.type = value; return this; }
public ArrayList<Integer> getWarrantyExtensionStatusIds() { return warrantyExtensionStatusIds; }
public ExportSellOut setWarrantyExtensionStatusIds(ArrayList<Integer> value) { this.warrantyExtensionStatusIds = value; return this; }
public String getDownloadRequestId() { return downloadRequestId; }
public ExportSellOut setDownloadRequestId(String value) { this.downloadRequestId = value; return this; }
}
public static class ProductCategory
{
/**
* Brand Category ID
*/
@ApiMember(Description="Brand Category ID")
public String brandCategoryId = null;
/**
* Grand Category ID
*/
@ApiMember(Description="Grand Category ID", IsRequired=true)
public String grandCategoryId = null;
/**
* Master Category ID
*/
@ApiMember(Description="Master Category ID")
public String masterCategoryId = null;
/**
* Category ID
*/
@ApiMember(Description="Category ID")
public String categoryId = null;
/**
* Sub Category ID
*/
@ApiMember(Description="Sub Category ID")
public String subCategoryId = null;
public String getBrandCategoryId() { return brandCategoryId; }
public ProductCategory setBrandCategoryId(String value) { this.brandCategoryId = value; return this; }
public String getGrandCategoryId() { return grandCategoryId; }
public ProductCategory setGrandCategoryId(String value) { this.grandCategoryId = value; return this; }
public String getMasterCategoryId() { return masterCategoryId; }
public ProductCategory setMasterCategoryId(String value) { this.masterCategoryId = value; return this; }
public String getCategoryId() { return categoryId; }
public ProductCategory setCategoryId(String value) { this.categoryId = value; return this; }
public String getSubCategoryId() { return subCategoryId; }
public ProductCategory setSubCategoryId(String value) { this.subCategoryId = value; return this; }
}
public static class ExportSellOutResponse
{
/**
* Unique Identifier of the Export Request created
*/
@ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
public UUID asyncTaskId = null;
public UUID getAsyncTaskId() { return asyncTaskId; }
public ExportSellOutResponse setAsyncTaskId(UUID value) { this.asyncTaskId = value; return this; }
}
}
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 /warranty/{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,
articleCodes:
[
String
],
productCategories:
[
{
brandCategoryId: String,
grandCategoryId: String,
masterCategoryId: String,
categoryId: String,
subCategoryId: String
}
],
saleRepresentativeEmails:
[
String
],
selloutType: String,
type: String,
warrantyExtensionStatusIds:
[
0
],
downloadRequestId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
asyncTaskId: 00000000000000000000000000000000
}