Richemont.Booster2.PublicApi

<back to all web services

ExportMovement

Requires Authentication
The following routes are available for this service:
POST/stock/{brand}/movement/exportExport Stock Movement Data
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 ExportMovement
            Inherits MovementsRequest
            '''<Summary>
            '''Export Request ID of the API Consumers
            '''</Summary>
            <ApiMember(Description:="Export Request ID of the API Consumers", IsRequired:=true)>
            Public Overridable Property downloadRequestId As String
        End Class

        Public Partial Class ExportMovementResponse
            '''<Summary>
            '''Unique Identifier of the Export Request created
            '''</Summary>
            <ApiMember(Description:="Unique Identifier of the Export Request created", IsRequired:=true)>
            Public Overridable Property asyncTaskId As Guid
        End Class

        Public Partial Class MovementsRequest
            Public Sub New()
                posCodes = New List(Of String)
                movementTypeIds = New List(Of Integer)
            End Sub

            '''<Summary>
            '''Brand
            '''</Summary>
            <ApiMember(Description:="Brand", IsRequired:=true)>
            Public Overridable Property brand As String

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

            '''<Summary>
            '''Movement Type Ids
            '''</Summary>
            <ApiMember(Description:="Movement Type Ids")>
            Public Overridable Property movementTypeIds As List(Of Integer)

            '''<Summary>
            '''Search Key (Article or SerialNumber)
            '''</Summary>
            <ApiMember(Description:="Search Key (Article or SerialNumber)")>
            Public Overridable Property searchKey As String

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

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

            '''<Summary>
            '''Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) 
            '''</Summary>
            <ApiMember(Description:="Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) ")>
            Public Overridable Property sortBy As String
        End Class
    End Namespace
End Namespace

VB.NET ExportMovement DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stock/{brand}/movement/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"downloadRequestId":"String","brand":"String","posCodes":["String"],"movementTypeIds":[0],"searchKey":"String","dateFrom":"\/Date(-62135596800000-0000)\/","dateTo":"\/Date(-62135596800000-0000)\/","sortBy":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"asyncTaskId":"00000000000000000000000000000000"}