| GET | /deliveryNote/{brand} | Get a list of Delivery Notes |
|---|
export class Amount2
{
/** @description Currency ISO Code e.g. EUR, USD */
// @ApiMember(Description="Currency ISO Code e.g. EUR, USD", IsRequired=true)
public currencyIsoCode: string;
/** @description Cost */
// @ApiMember(Description="Cost", IsRequired=true)
public value: number;
public constructor(init?: Partial<Amount2>) { (Object as any).assign(this, init); }
}
export class DeliveryNoteItem
{
/** @description 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 deliveryNotesLineNumber: number;
/** @description Status e.g. I, P */
// @ApiMember(Description="Status e.g. I, P", IsRequired=true)
public status: string;
/** @description Article code of product e.g. CRWGSA0032 */
// @ApiMember(Description="Article code of product e.g. CRWGSA0032", IsRequired=true)
public articleCode: string;
/** @description Article description of product */
// @ApiMember(Description="Article description of product")
public articleDescription: string;
/** @description Article code of product for straps e.g. CRKD12346879 */
// @ApiMember(Description="Article code of product for straps e.g. CRKD12346879")
public speakingArticleCode: string;
/** @description Serial numbers of products */
// @ApiMember(Description="Serial numbers of products")
public serialNumbers: string[];
/** @description 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 erpOrderNumber: number;
/** @description 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 erpOrderDate: string;
/** @description 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 erpOrderLineNumber: number;
/** @description Customer reference of order */
// @ApiMember(Description="Customer reference of order")
public customerReference: string;
/** @description Carrier name */
// @ApiMember(Description="Carrier name")
public carrier: string;
/** @description Tracking number */
// @ApiMember(Description="Tracking number")
public trackingNumber: string;
/** @description Tracking URL */
// @ApiMember(Description="Tracking URL")
public trackingUrl: string;
/** @description Flag that shows the order is sellable or not */
// @ApiMember(Description="Flag that shows the order is sellable or not", IsRequired=true)
public isSellable: boolean;
/** @description Flag that shows the order is consignment or not */
// @ApiMember(Description="Flag that shows the order is consignment or not", IsRequired=true)
public isConsignment: boolean;
/** @description 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 isAutomaticReplenishment: boolean;
/** @description Order reason code */
// @ApiMember(Description="Order reason code", IsRequired=true)
public orderReasonCode: string;
/** @description Original quantity of item */
// @ApiMember(Description="Original quantity of item")
public consignmentDueDate?: string;
/** @description Quantity of item */
// @ApiMember(Description="Quantity of item", IsRequired=true)
public quantity: number;
/** @description Price of item */
// @ApiMember(Description="Price of item", IsRequired=true)
public unitAmount: Amount2;
public constructor(init?: Partial<DeliveryNoteItem>) { (Object as any).assign(this, init); }
}
export class DeliveryNote
{
/** @description ID of ERP system e.g. ES100 */
// @ApiMember(Description="ID of ERP system e.g. ES100", IsRequired=true)
public erpSystemId: string;
/** @description POS Legacy e.g. ES100:102048 */
// @ApiMember(Description="POS Legacy e.g. ES100:102048", IsRequired=true)
public posCode: string;
/** @description ShipTo POS Legacy e.g. ES100:102048 */
// @ApiMember(Description="ShipTo POS Legacy e.g. ES100:102048", IsRequired=true)
public shipToPosCode: string;
/** @description ID of Delivery note document e.g. 7032150324 */
// @ApiMember(Description="ID of Delivery note document e.g. 7032150324", IsRequired=true)
public deliveryNotesNumber: number;
/** @description 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 deliveryNotesDate: string;
/** @description Delivery note items */
// @ApiMember(Description="Delivery note items", IsRequired=true)
public deliveryNoteItems: DeliveryNoteItem[];
/** @description ID of IC Delivery note document e.g. 7032150324 */
// @ApiMember(Description="ID of IC Delivery note document e.g. 7032150324", IsRequired=true)
public icDeliveryNotesNumber: number;
/** @description 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 icDeliveryNotesDate: string;
public constructor(init?: Partial<DeliveryNote>) { (Object as any).assign(this, init); }
}
export class GetDeliveryNotePaginatedResponse
{
/** @description Total Pages */
// @ApiMember(Description="Total Pages", IsRequired=true)
public totalPages: number;
/** @description Total Results */
// @ApiMember(Description="Total Results", IsRequired=true)
public totalResults: number;
/** @description Index of the result set returned */
// @ApiMember(Description="Index of the result set returned", IsRequired=true)
public page: number;
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned", IsRequired=true)
public items: number;
/** @description List of delivery notes */
// @ApiMember(Description="List of delivery notes", IsRequired=true)
public elements: DeliveryNote[];
public constructor(init?: Partial<GetDeliveryNotePaginatedResponse>) { (Object as any).assign(this, init); }
}
export class GetDeliveryNotePaginated implements IPagedRequest
{
/** @description Brand Trigram, e.g. CAR, IWC */
// @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
public brand: string;
/** @description POS Legacy Codes, e.g. ES100:102048 */
// @ApiMember(Description="POS Legacy Codes, e.g. ES100:102048", IsRequired=true)
public posCodes: string[];
/** @description Delivery notes date to */
// @ApiMember(Description="Delivery notes date to")
public dateTo?: string;
/** @description Delivery notes date from */
// @ApiMember(Description="Delivery notes date from")
public dateFrom?: string;
/** @description 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 status: string[];
/** @description Provide value 'true' for getting only consignment delivery notes */
// @ApiMember(Description="Provide value 'true' for getting only consignment delivery notes")
public onlyConsignment?: boolean;
/** @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. */
// @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 orderType?: string;
/** @description 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 stockType?: string;
/** @description Richemont Reference Code of the item */
// @ApiMember(Description="Richemont Reference Code of the item")
public articleCode?: string;
/** @description Serial Number of the item */
// @ApiMember(Description="Serial Number of the item")
public serialNumber?: string;
/** @description Delivery notes number for getting specific delivery, e.g. 7032150324 */
// @ApiMember(Description="Delivery notes number for getting specific delivery, e.g. 7032150324")
public deliveryNotesNumber?: number;
/** @description 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 icDeliveryNotesNumber?: number;
/** @description 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 erpOrderNumber?: number;
/** @description Index of the result set returned */
// @ApiMember(Description="Index of the result set returned")
public page: number;
/** @description Size of the result set returned */
// @ApiMember(Description="Size of the result set returned")
public items: number;
/** @description Omit precise record count - save on performance */
// @ApiMember(Description="Omit precise record count - save on performance")
public noCount: boolean;
/** @description Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC' */
// @ApiMember(Description="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")
public sortBy: string;
public constructor(init?: Partial<GetDeliveryNotePaginated>) { (Object as any).assign(this, init); }
}
TypeScript GetDeliveryNotePaginated DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"totalPages":0,"totalResults":0,"page":0,"items":0}