| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Purchase.ServiceModel;
namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel
{
public partial class Amount2
{
///<summary>
///Currency ISO Code e.g. EUR, USD
///</summary>
[ApiMember(Description="Currency ISO Code e.g. EUR, USD", IsRequired=true)]
public virtual string currencyIsoCode { get; set; }
///<summary>
///Cost
///</summary>
[ApiMember(Description="Cost", IsRequired=true)]
public virtual double value { get; set; }
}
public partial class DeliveryNote
{
public DeliveryNote()
{
deliveryNoteItems = new List<DeliveryNoteItem>{};
}
///<summary>
///ID of ERP system e.g. ES100
///</summary>
[ApiMember(Description="ID of ERP system e.g. ES100", IsRequired=true)]
public virtual string erpSystemId { get; set; }
///<summary>
///POS Legacy e.g. ES100:102048
///</summary>
[ApiMember(Description="POS Legacy e.g. ES100:102048", IsRequired=true)]
public virtual string posCode { get; set; }
///<summary>
///ShipTo POS Legacy e.g. ES100:102048
///</summary>
[ApiMember(Description="ShipTo POS Legacy e.g. ES100:102048", IsRequired=true)]
public virtual string shipToPosCode { get; set; }
///<summary>
///ID of Delivery note document e.g. 7032150324
///</summary>
[ApiMember(Description="ID of Delivery note document e.g. 7032150324", IsRequired=true)]
public virtual long deliveryNotesNumber { 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)]
public virtual DateTime deliveryNotesDate { get; set; }
///<summary>
///Delivery note items
///</summary>
[ApiMember(Description="Delivery note items", IsRequired=true)]
public virtual List<DeliveryNoteItem> deliveryNoteItems { 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)]
public virtual long? icDeliveryNotesNumber { 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)]
public virtual DateTime? icDeliveryNotesDate { get; set; }
}
public partial class DeliveryNoteItem
{
public DeliveryNoteItem()
{
serialNumbers = new List<string>{};
}
///<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)]
public virtual long deliveryNotesLineNumber { get; set; }
///<summary>
///Status e.g. I, P
///</summary>
[ApiMember(Description="Status e.g. I, P", IsRequired=true)]
public virtual string status { get; set; }
///<summary>
///Article code of product e.g. CRWGSA0032
///</summary>
[ApiMember(Description="Article code of product e.g. CRWGSA0032", IsRequired=true)]
public virtual string articleCode { get; set; }
///<summary>
///Article description of product
///</summary>
[ApiMember(Description="Article description of product")]
public virtual string articleDescription { get; set; }
///<summary>
///Article code of product for straps e.g. CRKD12346879
///</summary>
[ApiMember(Description="Article code of product for straps e.g. CRKD12346879")]
public virtual string speakingArticleCode { get; set; }
///<summary>
///Serial numbers of products
///</summary>
[ApiMember(Description="Serial numbers of products")]
public virtual List<string> serialNumbers { 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)]
public virtual int erpOrderNumber { 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)]
public virtual DateTime erpOrderDate { 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)]
public virtual int erpOrderLineNumber { get; set; }
///<summary>
///Customer reference of order
///</summary>
[ApiMember(Description="Customer reference of order")]
public virtual string customerReference { get; set; }
///<summary>
///Carrier name
///</summary>
[ApiMember(Description="Carrier name")]
public virtual string carrier { get; set; }
///<summary>
///Tracking number
///</summary>
[ApiMember(Description="Tracking number")]
public virtual string trackingNumber { get; set; }
///<summary>
///Tracking URL
///</summary>
[ApiMember(Description="Tracking URL")]
public virtual string trackingUrl { 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)]
public virtual bool isSellable { 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)]
public virtual bool isConsignment { 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)]
public virtual bool? isAutomaticReplenishment { get; set; }
///<summary>
///Order reason code
///</summary>
[ApiMember(Description="Order reason code", IsRequired=true)]
public virtual string orderReasonCode { get; set; }
///<summary>
///Original quantity of item
///</summary>
[ApiMember(Description="Original quantity of item")]
public virtual DateTime? consignmentDueDate { get; set; }
///<summary>
///Quantity of item
///</summary>
[ApiMember(Description="Quantity of item", IsRequired=true)]
public virtual int quantity { get; set; }
///<summary>
///Price of item
///</summary>
[ApiMember(Description="Price of item", IsRequired=true)]
public virtual Amount2 unitAmount { get; set; }
}
public partial class GetDeliveryNotePaginated
: IPagedRequest
{
public GetDeliveryNotePaginated()
{
posCodes = new List<string>{};
status = new List<string>{};
}
///<summary>
///Brand Trigram, e.g. CAR, IWC
///</summary>
[ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)]
public virtual string brand { get; set; }
///<summary>
///POS Legacy Codes, e.g. ES100:102048
///</summary>
[ApiMember(Description="POS Legacy Codes, e.g. ES100:102048", IsRequired=true)]
public virtual List<string> posCodes { get; set; }
///<summary>
///Delivery notes date to
///</summary>
[ApiMember(Description="Delivery notes date to")]
public virtual DateTime? dateTo { get; set; }
///<summary>
///Delivery notes date from
///</summary>
[ApiMember(Description="Delivery notes date from")]
public virtual DateTime? dateFrom { 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")]
public virtual List<string> status { get; set; }
///<summary>
///Provide value 'true' for getting only consignment delivery notes
///</summary>
[ApiMember(Description="Provide value 'true' for getting only consignment delivery notes")]
public virtual bool? onlyConsignment { 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.")]
public virtual string orderType { 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")]
public virtual string stockType { get; set; }
///<summary>
///Richemont Reference Code of the item
///</summary>
[ApiMember(Description="Richemont Reference Code of the item")]
public virtual string articleCode { get; set; }
///<summary>
///Serial Number of the item
///</summary>
[ApiMember(Description="Serial Number of the item")]
public virtual string serialNumber { 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")]
public virtual long? deliveryNotesNumber { 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")]
public virtual long? icDeliveryNotesNumber { 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")]
public virtual int? erpOrderNumber { get; set; }
///<summary>
///Index of the result set returned
///</summary>
[ApiMember(Description="Index of the result set returned")]
public virtual int page { get; set; }
///<summary>
///Size of the result set returned
///</summary>
[ApiMember(Description="Size of the result set returned")]
public virtual int items { get; set; }
///<summary>
///Omit precise record count - save on performance
///</summary>
[ApiMember(Description="Omit precise record count - save on performance")]
public virtual bool noCount { get; set; }
///<summary>
///Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'
///</summary>
[ApiMember(Description="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")]
public virtual string sortBy { get; set; }
}
public partial class GetDeliveryNotePaginatedResponse
{
///<summary>
///Total Pages
///</summary>
[ApiMember(Description="Total Pages", IsRequired=true)]
public virtual int totalPages { get; set; }
///<summary>
///Total Results
///</summary>
[ApiMember(Description="Total Results", IsRequired=true)]
public virtual int totalResults { get; set; }
///<summary>
///Index of the result set returned
///</summary>
[ApiMember(Description="Index of the result set returned", IsRequired=true)]
public virtual int page { get; set; }
///<summary>
///Size of the result set returned
///</summary>
[ApiMember(Description="Size of the result set returned", IsRequired=true)]
public virtual int items { get; set; }
///<summary>
///List of delivery notes
///</summary>
[ApiMember(Description="List of delivery notes", IsRequired=true)]
public virtual IEnumerable<DeliveryNote> elements { get; set; }
}
}
C# 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
}