| GET | /purchaseItem/{brand} | Get a list of purchase details |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GetPurchaseItems implements IPagedRequest
{
/**
* Brand
*/
@ApiMember(Description="Brand", IsRequired=true)
public String brand = null;
/**
* POS Legacy
*/
@ApiMember(Description="POS Legacy", IsRequired=true)
public ArrayList<String> posCodes = null;
/**
* Article Codes
*/
@ApiMember(Description="Article Codes")
public ArrayList<String> articleCodes = null;
/**
* ERP Order Codes
*/
@ApiMember(Description="ERP Order Codes")
public ArrayList<String> erpOrderCodes = null;
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned")
public Integer page = null;
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned")
public Integer items = null;
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
public Boolean noCount = null;
/**
* Sorting expression
*/
@ApiMember(Description="Sorting expression")
public String sortBy = null;
public String getBrand() { return brand; }
public GetPurchaseItems setBrand(String value) { this.brand = value; return this; }
public ArrayList<String> getPosCodes() { return posCodes; }
public GetPurchaseItems setPosCodes(ArrayList<String> value) { this.posCodes = value; return this; }
public ArrayList<String> getArticleCodes() { return articleCodes; }
public GetPurchaseItems setArticleCodes(ArrayList<String> value) { this.articleCodes = value; return this; }
public ArrayList<String> getErpOrderCodes() { return erpOrderCodes; }
public GetPurchaseItems setErpOrderCodes(ArrayList<String> value) { this.erpOrderCodes = value; return this; }
public Integer getPage() { return page; }
public GetPurchaseItems setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetPurchaseItems setItems(Integer value) { this.items = value; return this; }
public Boolean isNoCount() { return noCount; }
public GetPurchaseItems setNoCount(Boolean value) { this.noCount = value; return this; }
public String getSortBy() { return sortBy; }
public GetPurchaseItems setSortBy(String value) { this.sortBy = value; return this; }
}
public static class GetPurchaseItemsResponse
{
/**
* Total Pages
*/
@ApiMember(Description="Total Pages", IsRequired=true)
public Integer totalPages = null;
/**
* Total Results
*/
@ApiMember(Description="Total Results", IsRequired=true)
public Integer totalResults = null;
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
public Integer page = null;
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
public Integer items = null;
/**
* List of purchase items
*/
@ApiMember(Description="List of purchase items", IsRequired=true)
public ArrayList<PurchaseItem> elements = null;
public Integer getTotalPages() { return totalPages; }
public GetPurchaseItemsResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
public Integer getTotalResults() { return totalResults; }
public GetPurchaseItemsResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
public Integer getPage() { return page; }
public GetPurchaseItemsResponse setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetPurchaseItemsResponse setItems(Integer value) { this.items = value; return this; }
public ArrayList<PurchaseItem> getElements() { return elements; }
public GetPurchaseItemsResponse setElements(ArrayList<PurchaseItem> value) { this.elements = value; return this; }
}
public static class PurchaseItem
{
/**
* Pos Code
*/
@ApiMember(Description="Pos Code", IsRequired=true)
public String posCode = null;
/**
* Pos Code To Be Displayed
*/
@ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
public String posCodeToBeDisplayed = null;
/**
* Erp Order Id
*/
@ApiMember(Description="Erp Order Id", IsRequired=true)
public Integer erpOrderId = null;
/**
* Line number
*/
@ApiMember(Description="Line number", IsRequired=true)
public Integer lineNumber = null;
/**
* Order Date
*/
@ApiMember(Description="Order Date", IsRequired=true)
public String orderDate = null;
/**
* Origin Order Id
*/
@ApiMember(Description="Origin Order Id")
public Integer originOrderId = null;
/**
* Article Code
*/
@ApiMember(Description="Article Code", IsRequired=true)
public String articleCode = null;
/**
* Ordered Quantity
*/
@ApiMember(Description="Ordered Quantity", IsRequired=true)
public Integer orderedQuantity = null;
/**
* Open Quantity
*/
@ApiMember(Description="Open Quantity", IsRequired=true)
public Integer openQuantity = null;
/**
* Order status
*/
@ApiMember(Description="Order status", IsRequired=true)
public String status = null;
/**
* Net Amount
*/
@ApiMember(Description="Net Amount", IsRequired=true)
public Amount netAmount = null;
/**
* Customer Reference
*/
@ApiMember(Description="Customer Reference", IsRequired=true)
public String customerReference = null;
/**
* Speaking Article Code
*/
@ApiMember(Description="Speaking Article Code", IsRequired=true)
public String speakingArticleCode = null;
/**
* Expected Delivery Date
*/
@ApiMember(Description="Expected Delivery Date", IsRequired=true)
public String expectedDeliveryDate = null;
/**
* Is Strap Vip Order
*/
@ApiMember(Description="Is Strap Vip Order", IsRequired=true)
public Boolean isStrapVipOrder = null;
/**
* Order Type
*/
@ApiMember(Description="Order Type", IsRequired=true)
public String orderType = null;
public String getPosCode() { return posCode; }
public PurchaseItem setPosCode(String value) { this.posCode = value; return this; }
public String getPosCodeToBeDisplayed() { return posCodeToBeDisplayed; }
public PurchaseItem setPosCodeToBeDisplayed(String value) { this.posCodeToBeDisplayed = value; return this; }
public Integer getErpOrderId() { return erpOrderId; }
public PurchaseItem setErpOrderId(Integer value) { this.erpOrderId = value; return this; }
public Integer getLineNumber() { return lineNumber; }
public PurchaseItem setLineNumber(Integer value) { this.lineNumber = value; return this; }
public String getOrderDate() { return orderDate; }
public PurchaseItem setOrderDate(String value) { this.orderDate = value; return this; }
public Integer getOriginOrderId() { return originOrderId; }
public PurchaseItem setOriginOrderId(Integer value) { this.originOrderId = value; return this; }
public String getArticleCode() { return articleCode; }
public PurchaseItem setArticleCode(String value) { this.articleCode = value; return this; }
public Integer getOrderedQuantity() { return orderedQuantity; }
public PurchaseItem setOrderedQuantity(Integer value) { this.orderedQuantity = value; return this; }
public Integer getOpenQuantity() { return openQuantity; }
public PurchaseItem setOpenQuantity(Integer value) { this.openQuantity = value; return this; }
public String getStatus() { return status; }
public PurchaseItem setStatus(String value) { this.status = value; return this; }
public Amount getNetAmount() { return netAmount; }
public PurchaseItem setNetAmount(Amount value) { this.netAmount = value; return this; }
public String getCustomerReference() { return customerReference; }
public PurchaseItem setCustomerReference(String value) { this.customerReference = value; return this; }
public String getSpeakingArticleCode() { return speakingArticleCode; }
public PurchaseItem setSpeakingArticleCode(String value) { this.speakingArticleCode = value; return this; }
public String getExpectedDeliveryDate() { return expectedDeliveryDate; }
public PurchaseItem setExpectedDeliveryDate(String value) { this.expectedDeliveryDate = value; return this; }
public Boolean getIsStrapVipOrder() { return isStrapVipOrder; }
public PurchaseItem setIsStrapVipOrder(Boolean value) { this.isStrapVipOrder = value; return this; }
public String getOrderType() { return orderType; }
public PurchaseItem setOrderType(String value) { this.orderType = value; return this; }
}
public static class Amount
{
/**
* Value
*/
@ApiMember(Description="Value", IsRequired=true)
public BigDecimal value = null;
/**
* Currency
*/
@ApiMember(Description="Currency", IsRequired=true)
public String currency = null;
public BigDecimal getValue() { return value; }
public Amount setValue(BigDecimal value) { this.value = value; return this; }
public String getCurrency() { return currency; }
public Amount setCurrency(String value) { this.currency = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /purchaseItem/{brand} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetPurchaseItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel"> <elements i:nil="true" /> <items>0</items> <page>0</page> <totalPages>0</totalPages> <totalResults>0</totalResults> </GetPurchaseItemsResponse>