Richemont.Booster2.PublicApi

<back to all web services

GetTransferRequest

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/transferRequestGet Transfer RequestsGet a list of Transfer Requests related to given POSes
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Stock.ServiceModel

Namespace Global

    Namespace Richemont.Booster2.PublicApi.Stock.ServiceModel

        Public Partial Class GetTransferRequest
            Public Sub New()
                posCodes = 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>
            '''List of POS Codes in interest, e.g. ES100:102048,ES100:101469
            '''</Summary>
            <ApiMember(Description:="List of POS Codes in interest, e.g. ES100:102048,ES100:101469", IsRequired:=true)>
            Public Overridable Property posCodes As List(Of String)
        End Class

        Public Partial Class GetTransferRequestResponse
            Inherits List(Of TransferRequest)
        End Class

        Public Partial Class TransferRequest
            '''<Summary>
            '''Transfer Request ID, e.g. 1234567
            '''</Summary>
            <ApiMember(Description:="Transfer Request ID, e.g. 1234567", IsRequired:=true)>
            Public Overridable Property transferRequestId As Integer

            '''<Summary>
            '''Transfer Request Status: 'PEN', 'ACC', 'ERR', 'INP', 'COM', 'REJ', 'CAN'
            '''</Summary>
            <ApiMember(Description:="Transfer Request Status: 'PEN', 'ACC', 'ERR', 'INP', 'COM', 'REJ', 'CAN'", IsRequired:=true)>
            Public Overridable Property status As String

            '''<Summary>
            '''Transfer Request creation date e.g. 2022-01-01
            '''</Summary>
            <ApiMember(Description:="Transfer Request creation date e.g. 2022-01-01", IsRequired:=true)>
            Public Overridable Property createdDate As String

            '''<Summary>
            '''Transfer Request created user
            '''</Summary>
            <ApiMember(Description:="Transfer Request created user", IsRequired:=true)>
            Public Overridable Property createdBy As String

            '''<Summary>
            '''POS Code of the transfer Source POS, e.g. ES100:102048
            '''</Summary>
            <ApiMember(Description:="POS Code of the transfer Source POS, e.g. ES100:102048", IsRequired:=true)>
            Public Overridable Property posCodeFrom As String

            '''<Summary>
            '''POS Code of the transfer Target POS, e.g. ES100:101469
            '''</Summary>
            <ApiMember(Description:="POS Code of the transfer Target POS, e.g. ES100:101469", IsRequired:=true)>
            Public Overridable Property posCodeTo As String

            '''<Summary>
            '''Legacy Article Code of the item to be transferred
            '''</Summary>
            <ApiMember(Description:="Legacy Article Code of the item to be transferred", IsRequired:=true)>
            Public Overridable Property articleCode As String

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

            '''<Summary>
            '''Notes
            '''</Summary>
            <ApiMember(Description:="Notes")>
            Public Overridable Property notes As String

            '''<Summary>
            '''Return Number of the Authroization form document / PDF if exists
            '''</Summary>
            <ApiMember(Description:="Return Number of the Authroization form document / PDF if exists")>
            Public Overridable Property returnNumber As Nullable(Of Long)

            '''<Summary>
            '''Context of the Transfer request, can be either PUSH or PULL
            '''</Summary>
            <ApiMember(Description:="Context of the Transfer request, can be either PUSH or PULL")>
            Public Overridable Property context As String
        End Class
    End Namespace
End Namespace

VB.NET GetTransferRequest 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 /stock/{brand}/transferRequest HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[]