| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class GetDeliveryNotePaginated implements IPagedRequest
{
/**
* Brand Trigram, e.g. CAR, IWC
*/
@ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
public String brand = null;
/**
* POS Legacy Codes, e.g. ES100:102048
*/
@ApiMember(Description="POS Legacy Codes, e.g. ES100:102048", IsRequired=true)
public ArrayList<String> posCodes = null;
/**
* Delivery notes date to
*/
@ApiMember(Description="Delivery notes date to")
public Date dateTo = null;
/**
* Delivery notes date from
*/
@ApiMember(Description="Delivery notes date from")
public Date dateFrom = null;
/**
* Status possible values: 'I' for pending delivery notes, 'P' for accepted ones
*/
@ApiMember(Description="Status possible values: 'I' for pending delivery notes, 'P' for accepted ones")
public ArrayList<String> status = null;
/**
* Provide value 'true' for getting only consignment delivery notes
*/
@ApiMember(Description="Provide value 'true' for getting only consignment delivery notes")
public Boolean onlyConsignment = null;
/**
* Order type filter: “autorep“ for getting only delivery notes linked to an automatic replenishment trigger. It means the reason codes Auto Repl Standard (Z22) and Auto Repl Consignment (Z89) ; “manual“ for getting only delivery notes linked to a manual replenishment trigger. It means all the other reason codes.
*/
@ApiMember(Description="Order type filter: “autorep“ for getting only delivery notes linked to an automatic replenishment trigger. It means the reason codes Auto Repl Standard (Z22) and Auto Repl Consignment (Z89) ; “manual“ for getting only delivery notes linked to a manual replenishment trigger. It means all the other reason codes.")
public String orderType = null;
/**
* Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset
*/
@ApiMember(Description="Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset")
public String stockType = null;
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item")
public String articleCode = null;
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
public String serialNumber = null;
/**
* Delivery notes number for getting specific delivery, e.g. 7032150324
*/
@ApiMember(Description="Delivery notes number for getting specific delivery, e.g. 7032150324")
public Long deliveryNotesNumber = null;
/**
* IC Delivery notes number for getting specific delivery, e.g. 7032150324
*/
@ApiMember(Description="IC Delivery notes number for getting specific delivery, e.g. 7032150324")
public Long icDeliveryNotesNumber = null;
/**
* Purchase order number for getting specific deliveries by order number, e.g 207285022
*/
@ApiMember(Description="Purchase order number for getting specific deliveries by order number, e.g 207285022")
public Integer erpOrderNumber = 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;
/**
* Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'
*/
@ApiMember(Description="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")
public String sortBy = null;
public String getBrand() { return brand; }
public GetDeliveryNotePaginated setBrand(String value) { this.brand = value; return this; }
public ArrayList<String> getPosCodes() { return posCodes; }
public GetDeliveryNotePaginated setPosCodes(ArrayList<String> value) { this.posCodes = value; return this; }
public Date getDateTo() { return dateTo; }
public GetDeliveryNotePaginated setDateTo(Date value) { this.dateTo = value; return this; }
public Date getDateFrom() { return dateFrom; }
public GetDeliveryNotePaginated setDateFrom(Date value) { this.dateFrom = value; return this; }
public ArrayList<String> getStatus() { return status; }
public GetDeliveryNotePaginated setStatus(ArrayList<String> value) { this.status = value; return this; }
public Boolean isOnlyConsignment() { return onlyConsignment; }
public GetDeliveryNotePaginated setOnlyConsignment(Boolean value) { this.onlyConsignment = value; return this; }
public String getOrderType() { return orderType; }
public GetDeliveryNotePaginated setOrderType(String value) { this.orderType = value; return this; }
public String getStockType() { return stockType; }
public GetDeliveryNotePaginated setStockType(String value) { this.stockType = value; return this; }
public String getArticleCode() { return articleCode; }
public GetDeliveryNotePaginated setArticleCode(String value) { this.articleCode = value; return this; }
public String getSerialNumber() { return serialNumber; }
public GetDeliveryNotePaginated setSerialNumber(String value) { this.serialNumber = value; return this; }
public Long getDeliveryNotesNumber() { return deliveryNotesNumber; }
public GetDeliveryNotePaginated setDeliveryNotesNumber(Long value) { this.deliveryNotesNumber = value; return this; }
public Long getIcDeliveryNotesNumber() { return icDeliveryNotesNumber; }
public GetDeliveryNotePaginated setIcDeliveryNotesNumber(Long value) { this.icDeliveryNotesNumber = value; return this; }
public Integer getErpOrderNumber() { return erpOrderNumber; }
public GetDeliveryNotePaginated setErpOrderNumber(Integer value) { this.erpOrderNumber = value; return this; }
public Integer getPage() { return page; }
public GetDeliveryNotePaginated setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetDeliveryNotePaginated setItems(Integer value) { this.items = value; return this; }
public Boolean isNoCount() { return noCount; }
public GetDeliveryNotePaginated setNoCount(Boolean value) { this.noCount = value; return this; }
public String getSortBy() { return sortBy; }
public GetDeliveryNotePaginated setSortBy(String value) { this.sortBy = value; return this; }
}
public static class GetDeliveryNotePaginatedResponse
{
/**
* 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 delivery notes
*/
@ApiMember(Description="List of delivery notes", IsRequired=true)
public ArrayList<DeliveryNote> elements = null;
public Integer getTotalPages() { return totalPages; }
public GetDeliveryNotePaginatedResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
public Integer getTotalResults() { return totalResults; }
public GetDeliveryNotePaginatedResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
public Integer getPage() { return page; }
public GetDeliveryNotePaginatedResponse setPage(Integer value) { this.page = value; return this; }
public Integer getItems() { return items; }
public GetDeliveryNotePaginatedResponse setItems(Integer value) { this.items = value; return this; }
public ArrayList<DeliveryNote> getElements() { return elements; }
public GetDeliveryNotePaginatedResponse setElements(ArrayList<DeliveryNote> value) { this.elements = value; return this; }
}
public static class DeliveryNote
{
/**
* ID of ERP system e.g. ES100
*/
@ApiMember(Description="ID of ERP system e.g. ES100", IsRequired=true)
public String erpSystemId = null;
/**
* POS Legacy e.g. ES100:102048
*/
@ApiMember(Description="POS Legacy e.g. ES100:102048", IsRequired=true)
public String posCode = null;
/**
* ShipTo POS Legacy e.g. ES100:102048
*/
@ApiMember(Description="ShipTo POS Legacy e.g. ES100:102048", IsRequired=true)
public String shipToPosCode = null;
/**
* ID of Delivery note document e.g. 7032150324
*/
@ApiMember(Description="ID of Delivery note document e.g. 7032150324", IsRequired=true)
public Long deliveryNotesNumber = null;
/**
* Date of Delivery note document e.g. '2023-01-01'
*/
@ApiMember(Description="Date of Delivery note document e.g. '2023-01-01'", IsRequired=true)
public Date deliveryNotesDate = null;
/**
* Delivery note items
*/
@ApiMember(Description="Delivery note items", IsRequired=true)
public ArrayList<DeliveryNoteItem> deliveryNoteItems = null;
/**
* ID of IC Delivery note document e.g. 7032150324
*/
@ApiMember(Description="ID of IC Delivery note document e.g. 7032150324", IsRequired=true)
public Long icDeliveryNotesNumber = null;
/**
* Date of IC Delivery note document e.g. '2023-01-01'
*/
@ApiMember(Description="Date of IC Delivery note document e.g. '2023-01-01'", IsRequired=true)
public Date icDeliveryNotesDate = null;
public String getErpSystemId() { return erpSystemId; }
public DeliveryNote setErpSystemId(String value) { this.erpSystemId = value; return this; }
public String getPosCode() { return posCode; }
public DeliveryNote setPosCode(String value) { this.posCode = value; return this; }
public String getShipToPosCode() { return shipToPosCode; }
public DeliveryNote setShipToPosCode(String value) { this.shipToPosCode = value; return this; }
public Long getDeliveryNotesNumber() { return deliveryNotesNumber; }
public DeliveryNote setDeliveryNotesNumber(Long value) { this.deliveryNotesNumber = value; return this; }
public Date getDeliveryNotesDate() { return deliveryNotesDate; }
public DeliveryNote setDeliveryNotesDate(Date value) { this.deliveryNotesDate = value; return this; }
public ArrayList<DeliveryNoteItem> getDeliveryNoteItems() { return deliveryNoteItems; }
public DeliveryNote setDeliveryNoteItems(ArrayList<DeliveryNoteItem> value) { this.deliveryNoteItems = value; return this; }
public Long getIcDeliveryNotesNumber() { return icDeliveryNotesNumber; }
public DeliveryNote setIcDeliveryNotesNumber(Long value) { this.icDeliveryNotesNumber = value; return this; }
public Date getIcDeliveryNotesDate() { return icDeliveryNotesDate; }
public DeliveryNote setIcDeliveryNotesDate(Date value) { this.icDeliveryNotesDate = value; return this; }
}
public static class DeliveryNoteItem
{
/**
* Line number of Delivery note document e.g. 10, 90, 10000
*/
@ApiMember(Description="Line number of Delivery note document e.g. 10, 90, 10000", IsRequired=true)
public Long deliveryNotesLineNumber = null;
/**
* Status e.g. I, P
*/
@ApiMember(Description="Status e.g. I, P", IsRequired=true)
public String status = null;
/**
* Article code of product e.g. CRWGSA0032
*/
@ApiMember(Description="Article code of product e.g. CRWGSA0032", IsRequired=true)
public String articleCode = null;
/**
* Article description of product
*/
@ApiMember(Description="Article description of product")
public String articleDescription = null;
/**
* Article code of product for straps e.g. CRKD12346879
*/
@ApiMember(Description="Article code of product for straps e.g. CRKD12346879")
public String speakingArticleCode = null;
/**
* Serial numbers of products
*/
@ApiMember(Description="Serial numbers of products")
public ArrayList<String> serialNumbers = null;
/**
* ERP ID of purchase order which delivery note attached to e.g. 200232323
*/
@ApiMember(Description="ERP ID of purchase order which delivery note attached to e.g. 200232323", IsRequired=true)
public Integer erpOrderNumber = null;
/**
* Date of purchase order which delivery note attached to e.g. '2023-01-01'
*/
@ApiMember(Description="Date of purchase order which delivery note attached to e.g. '2023-01-01'", IsRequired=true)
public Date erpOrderDate = null;
/**
* Line number of purchase order which delivery note attached to e.g. '2023-01-01'
*/
@ApiMember(Description="Line number of purchase order which delivery note attached to e.g. '2023-01-01'", IsRequired=true)
public Integer erpOrderLineNumber = null;
/**
* Customer reference of order
*/
@ApiMember(Description="Customer reference of order")
public String customerReference = null;
/**
* Carrier name
*/
@ApiMember(Description="Carrier name")
public String carrier = null;
/**
* Tracking number
*/
@ApiMember(Description="Tracking number")
public String trackingNumber = null;
/**
* Tracking URL
*/
@ApiMember(Description="Tracking URL")
public String trackingUrl = null;
/**
* Flag that shows the order is sellable or not
*/
@ApiMember(Description="Flag that shows the order is sellable or not", IsRequired=true)
public Boolean isSellable = null;
/**
* Flag that shows the order is consignment or not
*/
@ApiMember(Description="Flag that shows the order is consignment or not", IsRequired=true)
public Boolean isConsignment = null;
/**
* Flag that shows the order is Automatic Replenishment or not
*/
@ApiMember(Description="Flag that shows the order is Automatic Replenishment or not", IsRequired=true)
public Boolean isAutomaticReplenishment = null;
/**
* Order reason code
*/
@ApiMember(Description="Order reason code", IsRequired=true)
public String orderReasonCode = null;
/**
* Original quantity of item
*/
@ApiMember(Description="Original quantity of item")
public Date consignmentDueDate = null;
/**
* Quantity of item
*/
@ApiMember(Description="Quantity of item", IsRequired=true)
public Integer quantity = null;
/**
* Price of item
*/
@ApiMember(Description="Price of item", IsRequired=true)
public Amount2 unitAmount = null;
public Long getDeliveryNotesLineNumber() { return deliveryNotesLineNumber; }
public DeliveryNoteItem setDeliveryNotesLineNumber(Long value) { this.deliveryNotesLineNumber = value; return this; }
public String getStatus() { return status; }
public DeliveryNoteItem setStatus(String value) { this.status = value; return this; }
public String getArticleCode() { return articleCode; }
public DeliveryNoteItem setArticleCode(String value) { this.articleCode = value; return this; }
public String getArticleDescription() { return articleDescription; }
public DeliveryNoteItem setArticleDescription(String value) { this.articleDescription = value; return this; }
public String getSpeakingArticleCode() { return speakingArticleCode; }
public DeliveryNoteItem setSpeakingArticleCode(String value) { this.speakingArticleCode = value; return this; }
public ArrayList<String> getSerialNumbers() { return serialNumbers; }
public DeliveryNoteItem setSerialNumbers(ArrayList<String> value) { this.serialNumbers = value; return this; }
public Integer getErpOrderNumber() { return erpOrderNumber; }
public DeliveryNoteItem setErpOrderNumber(Integer value) { this.erpOrderNumber = value; return this; }
public Date getErpOrderDate() { return erpOrderDate; }
public DeliveryNoteItem setErpOrderDate(Date value) { this.erpOrderDate = value; return this; }
public Integer getErpOrderLineNumber() { return erpOrderLineNumber; }
public DeliveryNoteItem setErpOrderLineNumber(Integer value) { this.erpOrderLineNumber = value; return this; }
public String getCustomerReference() { return customerReference; }
public DeliveryNoteItem setCustomerReference(String value) { this.customerReference = value; return this; }
public String getCarrier() { return carrier; }
public DeliveryNoteItem setCarrier(String value) { this.carrier = value; return this; }
public String getTrackingNumber() { return trackingNumber; }
public DeliveryNoteItem setTrackingNumber(String value) { this.trackingNumber = value; return this; }
public String getTrackingUrl() { return trackingUrl; }
public DeliveryNoteItem setTrackingUrl(String value) { this.trackingUrl = value; return this; }
public Boolean getIsSellable() { return isSellable; }
public DeliveryNoteItem setIsSellable(Boolean value) { this.isSellable = value; return this; }
public Boolean getIsConsignment() { return isConsignment; }
public DeliveryNoteItem setIsConsignment(Boolean value) { this.isConsignment = value; return this; }
public Boolean getIsAutomaticReplenishment() { return isAutomaticReplenishment; }
public DeliveryNoteItem setIsAutomaticReplenishment(Boolean value) { this.isAutomaticReplenishment = value; return this; }
public String getOrderReasonCode() { return orderReasonCode; }
public DeliveryNoteItem setOrderReasonCode(String value) { this.orderReasonCode = value; return this; }
public Date getConsignmentDueDate() { return consignmentDueDate; }
public DeliveryNoteItem setConsignmentDueDate(Date value) { this.consignmentDueDate = value; return this; }
public Integer getQuantity() { return quantity; }
public DeliveryNoteItem setQuantity(Integer value) { this.quantity = value; return this; }
public Amount2 getUnitAmount() { return unitAmount; }
public DeliveryNoteItem setUnitAmount(Amount2 value) { this.unitAmount = value; return this; }
}
public static class Amount2
{
/**
* Currency ISO Code e.g. EUR, USD
*/
@ApiMember(Description="Currency ISO Code e.g. EUR, USD", IsRequired=true)
public String currencyIsoCode = null;
/**
* Cost
*/
@ApiMember(Description="Cost", IsRequired=true)
public Double value = null;
public String getCurrencyIsoCode() { return currencyIsoCode; }
public Amount2 setCurrencyIsoCode(String value) { this.currencyIsoCode = value; return this; }
public Double getValue() { return value; }
public Amount2 setValue(Double value) { this.value = value; return this; }
}
}
Java GetDeliveryNotePaginated DTOs
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.
GET /deliveryNote/{brand} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalPages: 0,
totalResults: 0,
page: 0,
items: 0
}