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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetPurchaseItems : IPagedRequest
{
    /**
    * Brand
    */
    @ApiMember(Description="Brand", IsRequired=true)
    var brand:String? = null

    /**
    * POS Legacy
    */
    @ApiMember(Description="POS Legacy", IsRequired=true)
    var posCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Article Codes
    */
    @ApiMember(Description="Article Codes")
    var articleCodes:ArrayList<String> = ArrayList<String>()

    /**
    * ERP Order Codes
    */
    @ApiMember(Description="ERP Order Codes")
    var erpOrderCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Index of the result set returned
    */
    @ApiMember(Description="Index of the result set returned")
    var page:Int? = null

    /**
    * Size of the result set returned
    */
    @ApiMember(Description="Size of the result set returned")
    var items:Int? = null

    /**
    * Omit precise record count - save on performance
    */
    @ApiMember(Description="Omit precise record count - save on performance")
    var noCount:Boolean? = null

    /**
    * Sorting expression
    */
    @ApiMember(Description="Sorting expression")
    var sortBy:String? = null
}

open class GetPurchaseItemsResponse
{
    /**
    * Total Pages
    */
    @ApiMember(Description="Total Pages", IsRequired=true)
    var totalPages:Int? = null

    /**
    * Total Results
    */
    @ApiMember(Description="Total Results", IsRequired=true)
    var totalResults:Int? = null

    /**
    * Index of the result set returned
    */
    @ApiMember(Description="Index of the result set returned", IsRequired=true)
    var page:Int? = null

    /**
    * Size of the result set returned
    */
    @ApiMember(Description="Size of the result set returned", IsRequired=true)
    var items:Int? = null

    /**
    * List of purchase items
    */
    @ApiMember(Description="List of purchase items", IsRequired=true)
    var elements:ArrayList<PurchaseItem> = ArrayList<PurchaseItem>()
}

open class PurchaseItem
{
    /**
    * Pos Code
    */
    @ApiMember(Description="Pos Code", IsRequired=true)
    var posCode:String? = null

    /**
    * Pos Code To Be Displayed
    */
    @ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
    var posCodeToBeDisplayed:String? = null

    /**
    * Erp Order Id
    */
    @ApiMember(Description="Erp Order Id", IsRequired=true)
    var erpOrderId:Int? = null

    /**
    * Line number
    */
    @ApiMember(Description="Line number", IsRequired=true)
    var lineNumber:Int? = null

    /**
    * Order Date
    */
    @ApiMember(Description="Order Date", IsRequired=true)
    var orderDate:String? = null

    /**
    * Origin Order Id
    */
    @ApiMember(Description="Origin Order Id")
    var originOrderId:Int? = null

    /**
    * Article Code
    */
    @ApiMember(Description="Article Code", IsRequired=true)
    var articleCode:String? = null

    /**
    * Ordered Quantity
    */
    @ApiMember(Description="Ordered Quantity", IsRequired=true)
    var orderedQuantity:Int? = null

    /**
    * Open Quantity
    */
    @ApiMember(Description="Open Quantity", IsRequired=true)
    var openQuantity:Int? = null

    /**
    * Order status
    */
    @ApiMember(Description="Order status", IsRequired=true)
    var status:String? = null

    /**
    * Net Amount
    */
    @ApiMember(Description="Net Amount", IsRequired=true)
    var netAmount:Amount? = null

    /**
    * Customer Reference
    */
    @ApiMember(Description="Customer Reference", IsRequired=true)
    var customerReference:String? = null

    /**
    * Speaking Article Code
    */
    @ApiMember(Description="Speaking Article Code", IsRequired=true)
    var speakingArticleCode:String? = null

    /**
    * Expected Delivery Date
    */
    @ApiMember(Description="Expected Delivery Date", IsRequired=true)
    var expectedDeliveryDate:String? = null

    /**
    * Is Strap Vip Order
    */
    @ApiMember(Description="Is Strap Vip Order", IsRequired=true)
    var isStrapVipOrder:Boolean? = null

    /**
    * Order Type
    */
    @ApiMember(Description="Order Type", IsRequired=true)
    var orderType:String? = null
}

open class Amount
{
    /**
    * Value
    */
    @ApiMember(Description="Value", IsRequired=true)
    var value:BigDecimal? = null

    /**
    * Currency
    */
    @ApiMember(Description="Currency", IsRequired=true)
    var currency:String? = null
}

Kotlin GetPurchaseItems 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 /purchaseItem/{brand} 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}