| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Amount2() =
///<summary>
///Currency ISO Code e.g. EUR, USD
///</summary>
[<ApiMember(Description="Currency ISO Code e.g. EUR, USD", IsRequired=true)>]
member val currencyIsoCode:String = null with get,set
///<summary>
///Cost
///</summary>
[<ApiMember(Description="Cost", IsRequired=true)>]
member val value:Double = new Double() with get,set
[<AllowNullLiteral>]
type DeliveryNoteItem() =
///<summary>
///Line number of Delivery note document e.g. 10, 90, 10000
///</summary>
[<ApiMember(Description="Line number of Delivery note document e.g. 10, 90, 10000", IsRequired=true)>]
member val deliveryNotesLineNumber:Int64 = new Int64() with get,set
///<summary>
///Status e.g. I, P
///</summary>
[<ApiMember(Description="Status e.g. I, P", IsRequired=true)>]
member val status:String = null with get,set
///<summary>
///Article code of product e.g. CRWGSA0032
///</summary>
[<ApiMember(Description="Article code of product e.g. CRWGSA0032", IsRequired=true)>]
member val articleCode:String = null with get,set
///<summary>
///Article description of product
///</summary>
[<ApiMember(Description="Article description of product")>]
member val articleDescription:String = null with get,set
///<summary>
///Article code of product for straps e.g. CRKD12346879
///</summary>
[<ApiMember(Description="Article code of product for straps e.g. CRKD12346879")>]
member val speakingArticleCode:String = null with get,set
///<summary>
///Serial numbers of products
///</summary>
[<ApiMember(Description="Serial numbers of products")>]
member val serialNumbers:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///ERP ID of purchase order which delivery note attached to e.g. 200232323
///</summary>
[<ApiMember(Description="ERP ID of purchase order which delivery note attached to e.g. 200232323", IsRequired=true)>]
member val erpOrderNumber:Int32 = new Int32() with get,set
///<summary>
///Date of purchase order which delivery note attached to e.g. '2023-01-01'
///</summary>
[<ApiMember(Description="Date of purchase order which delivery note attached to e.g. '2023-01-01'", IsRequired=true)>]
member val erpOrderDate:DateTime = new DateTime() with get,set
///<summary>
///Line number of purchase order which delivery note attached to e.g. '2023-01-01'
///</summary>
[<ApiMember(Description="Line number of purchase order which delivery note attached to e.g. '2023-01-01'", IsRequired=true)>]
member val erpOrderLineNumber:Int32 = new Int32() with get,set
///<summary>
///Customer reference of order
///</summary>
[<ApiMember(Description="Customer reference of order")>]
member val customerReference:String = null with get,set
///<summary>
///Carrier name
///</summary>
[<ApiMember(Description="Carrier name")>]
member val carrier:String = null with get,set
///<summary>
///Tracking number
///</summary>
[<ApiMember(Description="Tracking number")>]
member val trackingNumber:String = null with get,set
///<summary>
///Tracking URL
///</summary>
[<ApiMember(Description="Tracking URL")>]
member val trackingUrl:String = null with get,set
///<summary>
///Flag that shows the order is sellable or not
///</summary>
[<ApiMember(Description="Flag that shows the order is sellable or not", IsRequired=true)>]
member val isSellable:Boolean = new Boolean() with get,set
///<summary>
///Flag that shows the order is consignment or not
///</summary>
[<ApiMember(Description="Flag that shows the order is consignment or not", IsRequired=true)>]
member val isConsignment:Boolean = new Boolean() with get,set
///<summary>
///Flag that shows the order is Automatic Replenishment or not
///</summary>
[<ApiMember(Description="Flag that shows the order is Automatic Replenishment or not", IsRequired=true)>]
member val isAutomaticReplenishment:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Order reason code
///</summary>
[<ApiMember(Description="Order reason code", IsRequired=true)>]
member val orderReasonCode:String = null with get,set
///<summary>
///Original quantity of item
///</summary>
[<ApiMember(Description="Original quantity of item")>]
member val consignmentDueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Quantity of item
///</summary>
[<ApiMember(Description="Quantity of item", IsRequired=true)>]
member val quantity:Int32 = new Int32() with get,set
///<summary>
///Price of item
///</summary>
[<ApiMember(Description="Price of item", IsRequired=true)>]
member val unitAmount:Amount2 = null with get,set
[<AllowNullLiteral>]
type DeliveryNote() =
///<summary>
///ID of ERP system e.g. ES100
///</summary>
[<ApiMember(Description="ID of ERP system e.g. ES100", IsRequired=true)>]
member val erpSystemId:String = null with get,set
///<summary>
///POS Legacy e.g. ES100:102048
///</summary>
[<ApiMember(Description="POS Legacy e.g. ES100:102048", IsRequired=true)>]
member val posCode:String = null with get,set
///<summary>
///ShipTo POS Legacy e.g. ES100:102048
///</summary>
[<ApiMember(Description="ShipTo POS Legacy e.g. ES100:102048", IsRequired=true)>]
member val shipToPosCode:String = null with get,set
///<summary>
///ID of Delivery note document e.g. 7032150324
///</summary>
[<ApiMember(Description="ID of Delivery note document e.g. 7032150324", IsRequired=true)>]
member val deliveryNotesNumber:Int64 = new Int64() with get,set
///<summary>
///Date of Delivery note document e.g. '2023-01-01'
///</summary>
[<ApiMember(Description="Date of Delivery note document e.g. '2023-01-01'", IsRequired=true)>]
member val deliveryNotesDate:DateTime = new DateTime() with get,set
///<summary>
///Delivery note items
///</summary>
[<ApiMember(Description="Delivery note items", IsRequired=true)>]
member val deliveryNoteItems:ResizeArray<DeliveryNoteItem> = new ResizeArray<DeliveryNoteItem>() with get,set
///<summary>
///ID of IC Delivery note document e.g. 7032150324
///</summary>
[<ApiMember(Description="ID of IC Delivery note document e.g. 7032150324", IsRequired=true)>]
member val icDeliveryNotesNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///Date of IC Delivery note document e.g. '2023-01-01'
///</summary>
[<ApiMember(Description="Date of IC Delivery note document e.g. '2023-01-01'", IsRequired=true)>]
member val icDeliveryNotesDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type GetDeliveryNotePaginatedResponse() =
///<summary>
///Total Pages
///</summary>
[<ApiMember(Description="Total Pages", IsRequired=true)>]
member val totalPages:Int32 = new Int32() with get,set
///<summary>
///Total Results
///</summary>
[<ApiMember(Description="Total Results", IsRequired=true)>]
member val totalResults:Int32 = new Int32() with get,set
///<summary>
///Index of the result set returned
///</summary>
[<ApiMember(Description="Index of the result set returned", IsRequired=true)>]
member val page:Int32 = new Int32() with get,set
///<summary>
///Size of the result set returned
///</summary>
[<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
member val items:Int32 = new Int32() with get,set
///<summary>
///List of delivery notes
///</summary>
[<ApiMember(Description="List of delivery notes", IsRequired=true)>]
member val elements:IEnumerable<DeliveryNote> = null with get,set
[<AllowNullLiteral>]
type GetDeliveryNotePaginated() =
///<summary>
///Brand Trigram, e.g. CAR, IWC
///</summary>
[<ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)>]
member val brand:String = null with get,set
///<summary>
///POS Legacy Codes, e.g. ES100:102048
///</summary>
[<ApiMember(Description="POS Legacy Codes, e.g. ES100:102048", IsRequired=true)>]
member val posCodes:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Delivery notes date to
///</summary>
[<ApiMember(Description="Delivery notes date to")>]
member val dateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Delivery notes date from
///</summary>
[<ApiMember(Description="Delivery notes date from")>]
member val dateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Status possible values: 'I' for pending delivery notes, 'P' for accepted ones
///</summary>
[<ApiMember(Description="Status possible values: 'I' for pending delivery notes, 'P' for accepted ones")>]
member val status:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Provide value 'true' for getting only consignment delivery notes
///</summary>
[<ApiMember(Description="Provide value 'true' for getting only consignment delivery notes")>]
member val onlyConsignment:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///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.
///</summary>
[<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.")>]
member val orderType:String = null with get,set
///<summary>
///Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset
///</summary>
[<ApiMember(Description="Stock type filter: “consigned“ for consigned products only ; “asset“ for standard products only ; empty for both consignment & asset")>]
member val stockType:String = null with get,set
///<summary>
///Richemont Reference Code of the item
///</summary>
[<ApiMember(Description="Richemont Reference Code of the item")>]
member val articleCode:String = null with get,set
///<summary>
///Serial Number of the item
///</summary>
[<ApiMember(Description="Serial Number of the item")>]
member val serialNumber:String = null with get,set
///<summary>
///Delivery notes number for getting specific delivery, e.g. 7032150324
///</summary>
[<ApiMember(Description="Delivery notes number for getting specific delivery, e.g. 7032150324")>]
member val deliveryNotesNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///IC Delivery notes number for getting specific delivery, e.g. 7032150324
///</summary>
[<ApiMember(Description="IC Delivery notes number for getting specific delivery, e.g. 7032150324")>]
member val icDeliveryNotesNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///Purchase order number for getting specific deliveries by order number, e.g 207285022
///</summary>
[<ApiMember(Description="Purchase order number for getting specific deliveries by order number, e.g 207285022")>]
member val erpOrderNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Index of the result set returned
///</summary>
[<ApiMember(Description="Index of the result set returned")>]
member val page:Int32 = new Int32() with get,set
///<summary>
///Size of the result set returned
///</summary>
[<ApiMember(Description="Size of the result set returned")>]
member val items:Int32 = new Int32() with get,set
///<summary>
///Omit precise record count - save on performance
///</summary>
[<ApiMember(Description="Omit precise record count - save on performance")>]
member val noCount:Boolean = new Boolean() with get,set
///<summary>
///Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'
///</summary>
[<ApiMember(Description="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")>]
member val sortBy:String = null with get,set
F# GetDeliveryNotePaginated DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"totalPages":0,"totalResults":0,"page":0,"items":0}