Richemont.Booster2.PublicApi

<back to all web services

GetPurchaseItems

Requires Authentication
The following routes are available for this service:
GET/purchaseItem/{brand}Get a list of purchase details
namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel

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

    [<AllowNullLiteral>]
    type Amount() = 
        ///<summary>
        ///Value
        ///</summary>
        [<ApiMember(Description="Value", IsRequired=true)>]
        member val value:Decimal = new Decimal() with get,set

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

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

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

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

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

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

        ///<summary>
        ///Origin Order Id
        ///</summary>
        [<ApiMember(Description="Origin Order Id")>]
        member val originOrderId:Nullable<Int32> = new Nullable<Int32>() with get,set

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

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

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

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

        ///<summary>
        ///Net Amount
        ///</summary>
        [<ApiMember(Description="Net Amount", IsRequired=true)>]
        member val netAmount:Amount = null with get,set

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

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

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

        ///<summary>
        ///Is Strap Vip Order
        ///</summary>
        [<ApiMember(Description="Is Strap Vip Order", IsRequired=true)>]
        member val isStrapVipOrder:Boolean = new Boolean() with get,set

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

    [<AllowNullLiteral>]
    type GetPurchaseItemsResponse() = 
        ///<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 purchase items
        ///</summary>
        [<ApiMember(Description="List of purchase items", IsRequired=true)>]
        member val elements:IEnumerable<PurchaseItem> = null with get,set

    [<AllowNullLiteral>]
    type GetPurchaseItems() = 
        ///<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>
        ///Article Codes
        ///</summary>
        [<ApiMember(Description="Article Codes")>]
        member val articleCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///ERP Order Codes
        ///</summary>
        [<ApiMember(Description="ERP Order Codes")>]
        member val erpOrderCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<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

        ///<summary>
        ///Sorting expression
        ///</summary>
        [<ApiMember(Description="Sorting expression")>]
        member val sortBy:String = null with get,set

F# GetPurchaseItems DTOs

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

HTTP + CSV

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

GET /purchaseItem/{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}