Richemont.Booster2.PublicApi

<back to all web services

GetDeliveryNotePaginated

Requires Authentication
The following routes are available for this service:
GET/deliveryNote/{brand}Get a list of Delivery Notes
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Purchase.ServiceModel

Namespace Global

    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 Overridable Property currencyIsoCode As String

            '''<Summary>
            '''Cost
            '''</Summary>
            <ApiMember(Description:="Cost", IsRequired:=true)>
            Public Overridable Property value As Double
        End Class

        Public Partial Class DeliveryNote
            Public Sub New()
                deliveryNoteItems = New List(Of DeliveryNoteItem)
            End Sub

            '''<Summary>
            '''ID of ERP system e.g. ES100
            '''</Summary>
            <ApiMember(Description:="ID of ERP system e.g. ES100", IsRequired:=true)>
            Public Overridable Property erpSystemId As String

            '''<Summary>
            '''POS Legacy e.g. ES100:102048
            '''</Summary>
            <ApiMember(Description:="POS Legacy e.g. ES100:102048", IsRequired:=true)>
            Public Overridable Property posCode As String

            '''<Summary>
            '''ShipTo POS Legacy e.g. ES100:102048
            '''</Summary>
            <ApiMember(Description:="ShipTo POS Legacy e.g. ES100:102048", IsRequired:=true)>
            Public Overridable Property shipToPosCode As String

            '''<Summary>
            '''ID of Delivery note document e.g. 7032150324
            '''</Summary>
            <ApiMember(Description:="ID of Delivery note document e.g. 7032150324", IsRequired:=true)>
            Public Overridable Property deliveryNotesNumber As Long

            '''<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 Overridable Property deliveryNotesDate As Date

            '''<Summary>
            '''Delivery note items
            '''</Summary>
            <ApiMember(Description:="Delivery note items", IsRequired:=true)>
            Public Overridable Property deliveryNoteItems As List(Of DeliveryNoteItem)

            '''<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 Overridable Property icDeliveryNotesNumber As Nullable(Of Long)

            '''<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 Overridable Property icDeliveryNotesDate As Nullable(Of Date)
        End Class

        Public Partial Class DeliveryNoteItem
            Public Sub New()
                serialNumbers = New List(Of String)
            End Sub

            '''<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 Overridable Property deliveryNotesLineNumber As Long

            '''<Summary>
            '''Status e.g. I, P
            '''</Summary>
            <ApiMember(Description:="Status e.g. I, P", IsRequired:=true)>
            Public Overridable Property status As String

            '''<Summary>
            '''Article code of product e.g. CRWGSA0032
            '''</Summary>
            <ApiMember(Description:="Article code of product e.g. CRWGSA0032", IsRequired:=true)>
            Public Overridable Property articleCode As String

            '''<Summary>
            '''Article description of product
            '''</Summary>
            <ApiMember(Description:="Article description of product")>
            Public Overridable Property articleDescription As String

            '''<Summary>
            '''Article code of product for straps e.g. CRKD12346879
            '''</Summary>
            <ApiMember(Description:="Article code of product for straps e.g. CRKD12346879")>
            Public Overridable Property speakingArticleCode As String

            '''<Summary>
            '''Serial numbers of products
            '''</Summary>
            <ApiMember(Description:="Serial numbers of products")>
            Public Overridable Property serialNumbers As List(Of String)

            '''<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 Overridable Property erpOrderNumber As Integer

            '''<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 Overridable Property erpOrderDate As Date

            '''<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 Overridable Property erpOrderLineNumber As Integer

            '''<Summary>
            '''Customer reference of order
            '''</Summary>
            <ApiMember(Description:="Customer reference of order")>
            Public Overridable Property customerReference As String

            '''<Summary>
            '''Carrier name
            '''</Summary>
            <ApiMember(Description:="Carrier name")>
            Public Overridable Property carrier As String

            '''<Summary>
            '''Tracking number
            '''</Summary>
            <ApiMember(Description:="Tracking number")>
            Public Overridable Property trackingNumber As String

            '''<Summary>
            '''Tracking URL
            '''</Summary>
            <ApiMember(Description:="Tracking URL")>
            Public Overridable Property trackingUrl As String

            '''<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 Overridable Property isSellable As Boolean

            '''<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 Overridable Property isConsignment As Boolean

            '''<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 Overridable Property isAutomaticReplenishment As Nullable(Of Boolean)

            '''<Summary>
            '''Order reason code
            '''</Summary>
            <ApiMember(Description:="Order reason code", IsRequired:=true)>
            Public Overridable Property orderReasonCode As String

            '''<Summary>
            '''Original quantity of item
            '''</Summary>
            <ApiMember(Description:="Original quantity of item")>
            Public Overridable Property consignmentDueDate As Nullable(Of Date)

            '''<Summary>
            '''Quantity of item
            '''</Summary>
            <ApiMember(Description:="Quantity of item", IsRequired:=true)>
            Public Overridable Property quantity As Integer

            '''<Summary>
            '''Price of item
            '''</Summary>
            <ApiMember(Description:="Price of item", IsRequired:=true)>
            Public Overridable Property unitAmount As Amount2
        End Class

        Public Partial Class GetDeliveryNotePaginated
            Implements IPagedRequest
            Public Sub New()
                posCodes = New List(Of String)
                status = New List(Of String)
            End Sub

            '''<Summary>
            '''Brand Trigram, e.g. CAR, IWC
            '''</Summary>
            <ApiMember(Description:="Brand Trigram, e.g. CAR, IWC", IsRequired:=true)>
            Public Overridable Property brand As String

            '''<Summary>
            '''POS Legacy Codes, e.g. ES100:102048
            '''</Summary>
            <ApiMember(Description:="POS Legacy Codes, e.g. ES100:102048", IsRequired:=true)>
            Public Overridable Property posCodes As List(Of String)

            '''<Summary>
            '''Delivery notes date to
            '''</Summary>
            <ApiMember(Description:="Delivery notes date to")>
            Public Overridable Property dateTo As Nullable(Of Date)

            '''<Summary>
            '''Delivery notes date from
            '''</Summary>
            <ApiMember(Description:="Delivery notes date from")>
            Public Overridable Property dateFrom As Nullable(Of Date)

            '''<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 Overridable Property status As List(Of String)

            '''<Summary>
            '''Provide value 'true' for getting only consignment delivery notes
            '''</Summary>
            <ApiMember(Description:="Provide value 'true' for getting only consignment delivery notes")>
            Public Overridable Property onlyConsignment As Nullable(Of Boolean)

            '''<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 Overridable Property orderType As String

            '''<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 Overridable Property stockType As String

            '''<Summary>
            '''Richemont Reference Code of the item
            '''</Summary>
            <ApiMember(Description:="Richemont Reference Code of the item")>
            Public Overridable Property articleCode As String

            '''<Summary>
            '''Serial Number of the item
            '''</Summary>
            <ApiMember(Description:="Serial Number of the item")>
            Public Overridable Property serialNumber As String

            '''<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 Overridable Property deliveryNotesNumber As Nullable(Of Long)

            '''<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 Overridable Property icDeliveryNotesNumber As Nullable(Of Long)

            '''<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 Overridable Property erpOrderNumber As Nullable(Of Integer)

            '''<Summary>
            '''Index of the result set returned
            '''</Summary>
            <ApiMember(Description:="Index of the result set returned")>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned")>
            Public Overridable Property items As Integer

            '''<Summary>
            '''Omit precise record count - save on performance
            '''</Summary>
            <ApiMember(Description:="Omit precise record count - save on performance")>
            Public Overridable Property noCount As Boolean

            '''<Summary>
            '''Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'
            '''</Summary>
            <ApiMember(Description:="Values can be 'DateDESC', 'DateASC', 'PosASC', 'PosDESC'")>
            Public Overridable Property sortBy As String
        End Class

        Public Partial Class GetDeliveryNotePaginatedResponse
            '''<Summary>
            '''Total Pages
            '''</Summary>
            <ApiMember(Description:="Total Pages", IsRequired:=true)>
            Public Overridable Property totalPages As Integer

            '''<Summary>
            '''Total Results
            '''</Summary>
            <ApiMember(Description:="Total Results", IsRequired:=true)>
            Public Overridable Property totalResults As Integer

            '''<Summary>
            '''Index of the result set returned
            '''</Summary>
            <ApiMember(Description:="Index of the result set returned", IsRequired:=true)>
            Public Overridable Property page As Integer

            '''<Summary>
            '''Size of the result set returned
            '''</Summary>
            <ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
            Public Overridable Property items As Integer

            '''<Summary>
            '''List of delivery notes
            '''</Summary>
            <ApiMember(Description:="List of delivery notes", IsRequired:=true)>
            Public Overridable Property elements As IEnumerable(Of DeliveryNote)
        End Class
    End Namespace
End Namespace

VB.NET 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

HTTP + JSON

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}