| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetDeliveryNotePaginated : IPagedRequest
{
/**
* Brand Trigram, e.g. CAR, IWC
*/
@ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
var brand:String? = null
/**
* POS Legacy Codes, e.g. ES100:102048
*/
@ApiMember(Description="POS Legacy Codes, e.g. ES100:102048", IsRequired=true)
var posCodes:ArrayList<String> = ArrayList<String>()
/**
* Delivery notes date to
*/
@ApiMember(Description="Delivery notes date to")
var dateTo:Date? = null
/**
* Delivery notes date from
*/
@ApiMember(Description="Delivery notes date from")
var dateFrom:Date? = 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")
var status:ArrayList<String> = ArrayList<String>()
/**
* Provide value 'true' for getting only consignment delivery notes
*/
@ApiMember(Description="Provide value 'true' for getting only consignment delivery notes")
var onlyConsignment:Boolean? = 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.")
var orderType:String? = 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")
var stockType:String? = null
/**
* Richemont Reference Code of the item
*/
@ApiMember(Description="Richemont Reference Code of the item")
var articleCode:String? = null
/**
* Serial Number of the item
*/
@ApiMember(Description="Serial Number of the item")
var serialNumber:String? = null
/**
* Delivery notes number for getting specific delivery, e.g. 7032150324
*/
@ApiMember(Description="Delivery notes number for getting specific delivery, e.g. 7032150324")
var deliveryNotesNumber:Long? = 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")
var icDeliveryNotesNumber:Long? = 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")
var erpOrderNumber:Int? = null
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned")
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned")
var items:Int? = null
/**
* Omit precise record count - save on performance
*/
@ApiMember(Description="Omit precise record count - save on performance")
var noCount:Boolean? = null
/**
* Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'
*/
@ApiMember(Description="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")
var sortBy:String? = null
}
open class GetDeliveryNotePaginatedResponse
{
/**
* Total Pages
*/
@ApiMember(Description="Total Pages", IsRequired=true)
var totalPages:Int? = null
/**
* Total Results
*/
@ApiMember(Description="Total Results", IsRequired=true)
var totalResults:Int? = null
/**
* Index of the result set returned
*/
@ApiMember(Description="Index of the result set returned", IsRequired=true)
var page:Int? = null
/**
* Size of the result set returned
*/
@ApiMember(Description="Size of the result set returned", IsRequired=true)
var items:Int? = null
/**
* List of delivery notes
*/
@ApiMember(Description="List of delivery notes", IsRequired=true)
var elements:ArrayList<DeliveryNote> = ArrayList<DeliveryNote>()
}
open class DeliveryNote
{
/**
* ID of ERP system e.g. ES100
*/
@ApiMember(Description="ID of ERP system e.g. ES100", IsRequired=true)
var erpSystemId:String? = null
/**
* POS Legacy e.g. ES100:102048
*/
@ApiMember(Description="POS Legacy e.g. ES100:102048", IsRequired=true)
var posCode:String? = null
/**
* ShipTo POS Legacy e.g. ES100:102048
*/
@ApiMember(Description="ShipTo POS Legacy e.g. ES100:102048", IsRequired=true)
var shipToPosCode:String? = null
/**
* ID of Delivery note document e.g. 7032150324
*/
@ApiMember(Description="ID of Delivery note document e.g. 7032150324", IsRequired=true)
var deliveryNotesNumber:Long? = 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)
var deliveryNotesDate:Date? = null
/**
* Delivery note items
*/
@ApiMember(Description="Delivery note items", IsRequired=true)
var deliveryNoteItems:ArrayList<DeliveryNoteItem> = ArrayList<DeliveryNoteItem>()
/**
* ID of IC Delivery note document e.g. 7032150324
*/
@ApiMember(Description="ID of IC Delivery note document e.g. 7032150324", IsRequired=true)
var icDeliveryNotesNumber:Long? = 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)
var icDeliveryNotesDate:Date? = null
}
open 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)
var deliveryNotesLineNumber:Long? = null
/**
* Status e.g. I, P
*/
@ApiMember(Description="Status e.g. I, P", IsRequired=true)
var status:String? = null
/**
* Article code of product e.g. CRWGSA0032
*/
@ApiMember(Description="Article code of product e.g. CRWGSA0032", IsRequired=true)
var articleCode:String? = null
/**
* Article description of product
*/
@ApiMember(Description="Article description of product")
var articleDescription:String? = null
/**
* Article code of product for straps e.g. CRKD12346879
*/
@ApiMember(Description="Article code of product for straps e.g. CRKD12346879")
var speakingArticleCode:String? = null
/**
* Serial numbers of products
*/
@ApiMember(Description="Serial numbers of products")
var serialNumbers:ArrayList<String> = ArrayList<String>()
/**
* 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)
var erpOrderNumber:Int? = 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)
var erpOrderDate:Date? = 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)
var erpOrderLineNumber:Int? = null
/**
* Customer reference of order
*/
@ApiMember(Description="Customer reference of order")
var customerReference:String? = null
/**
* Carrier name
*/
@ApiMember(Description="Carrier name")
var carrier:String? = null
/**
* Tracking number
*/
@ApiMember(Description="Tracking number")
var trackingNumber:String? = null
/**
* Tracking URL
*/
@ApiMember(Description="Tracking URL")
var trackingUrl:String? = null
/**
* Flag that shows the order is sellable or not
*/
@ApiMember(Description="Flag that shows the order is sellable or not", IsRequired=true)
var isSellable:Boolean? = null
/**
* Flag that shows the order is consignment or not
*/
@ApiMember(Description="Flag that shows the order is consignment or not", IsRequired=true)
var isConsignment:Boolean? = 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)
var isAutomaticReplenishment:Boolean? = null
/**
* Order reason code
*/
@ApiMember(Description="Order reason code", IsRequired=true)
var orderReasonCode:String? = null
/**
* Original quantity of item
*/
@ApiMember(Description="Original quantity of item")
var consignmentDueDate:Date? = null
/**
* Quantity of item
*/
@ApiMember(Description="Quantity of item", IsRequired=true)
var quantity:Int? = null
/**
* Price of item
*/
@ApiMember(Description="Price of item", IsRequired=true)
var unitAmount:Amount2? = null
}
open class Amount2
{
/**
* Currency ISO Code e.g. EUR, USD
*/
@ApiMember(Description="Currency ISO Code e.g. EUR, USD", IsRequired=true)
var currencyIsoCode:String? = null
/**
* Cost
*/
@ApiMember(Description="Cost", IsRequired=true)
var value:Double? = null
}
Kotlin GetDeliveryNotePaginated DTOs
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 /deliveryNote/{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 <GetDeliveryNotePaginatedResponse 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> </GetDeliveryNotePaginatedResponse>