Richemont.Booster2.PublicApi

<back to all web services

GetMovements

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/movementGet movements
namespace Richemont.Booster2.PublicApi.Stock.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Movement() = 
        ///<summary>
        ///Movement Id
        ///</summary>
        [<ApiMember(Description="Movement Id", IsRequired=true)>]
        member val movementId:Int32 = new Int32() with get,set

        ///<summary>
        ///Pos Code
        ///</summary>
        [<ApiMember(Description="Pos Code", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///Pos Name
        ///</summary>
        [<ApiMember(Description="Pos Name", IsRequired=true)>]
        member val posName:String = null with get,set

        ///<summary>
        ///Created By
        ///</summary>
        [<ApiMember(Description="Created By", IsRequired=true)>]
        member val createdBy:String = null with get,set

        ///<summary>
        ///Movement Date
        ///</summary>
        [<ApiMember(Description="Movement Date", IsRequired=true)>]
        member val movementDate:String = null with get,set

        ///<summary>
        ///Article Code
        ///</summary>
        [<ApiMember(Description="Article Code", IsRequired=true)>]
        member val articleCode:String = null with get,set

        ///<summary>
        ///Serial Number
        ///</summary>
        [<ApiMember(Description="Serial Number", IsRequired=true)>]
        member val serialNumber:String = null with get,set

        ///<summary>
        ///Quantity
        ///</summary>
        [<ApiMember(Description="Quantity", IsRequired=true)>]
        member val quantity:Int32 = new Int32() with get,set

        ///<summary>
        ///Movement Type Id
        ///</summary>
        [<ApiMember(Description="Movement Type Id", IsRequired=true)>]
        member val movementTypeId:Int32 = new Int32() with get,set

        ///<summary>
        ///Comments
        ///</summary>
        [<ApiMember(Description="Comments", IsRequired=true)>]
        member val comments:String = null with get,set

    [<AllowNullLiteral>]
    type GetMovementsResponse() = 
        ///<summary>
        ///Total Pages
        ///</summary>
        [<ApiMember(Description="Total Pages", IsRequired=true)>]
        member val totalPages:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Results
        ///</summary>
        [<ApiMember(Description="Total Results", IsRequired=true)>]
        member val totalResults:Int32 = new Int32() with get,set

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [<ApiMember(Description="Index of the result set returned", IsRequired=true)>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned", IsRequired=true)>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///List of movements
        ///</summary>
        [<ApiMember(Description="List of movements", IsRequired=true)>]
        member val elements:IEnumerable<Movement> = null with get,set

    [<AllowNullLiteral>]
    type MovementsRequest() = 
        ///<summary>
        ///Brand
        ///</summary>
        [<ApiMember(Description="Brand", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///POS Legacy
        ///</summary>
        [<ApiMember(Description="POS Legacy", IsRequired=true)>]
        member val posCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Movement Type Ids
        ///</summary>
        [<ApiMember(Description="Movement Type Ids")>]
        member val movementTypeIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        ///<summary>
        ///Search Key (Article or SerialNumber)
        ///</summary>
        [<ApiMember(Description="Search Key (Article or SerialNumber)")>]
        member val searchKey:String = null with get,set

        ///<summary>
        ///In Stock Since date from 
        ///</summary>
        [<ApiMember(Description="In Stock Since date from ")>]
        member val dateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///In Stock Since date to
        ///</summary>
        [<ApiMember(Description="In Stock Since date to")>]
        member val dateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<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) ")>]
        member val sortBy:String = null with get,set

    [<AllowNullLiteral>]
    type GetMovements() = 
        inherit MovementsRequest()
        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [<ApiMember(Description="Index of the result set returned")>]
        member val page:Int32 = new Int32() with get,set

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [<ApiMember(Description="Size of the result set returned")>]
        member val items:Int32 = new Int32() with get,set

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [<ApiMember(Description="Omit precise record count - save on performance")>]
        member val noCount:Boolean = new Boolean() with get,set

F# GetMovements 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.

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

{"totalPages":0,"totalResults":0,"page":0,"items":0}