| GET | /buyin/{brand} | Get list of buyin | Get list of paginated buyin based on the search parameters submitted |
|---|
namespace Richemont.Booster2.PublicApi.CPO.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BuyIn() =
///<summary>
///Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided
///</summary>
[<ApiMember(Description="Brand Trigram, e.g. CAR, IWC; compulsory only if articleCode is not provided", IsRequired=true)>]
member val brand:String = null with get,set
///<summary>
///Code of BuyIn
///</summary>
[<ApiMember(Description="Code of BuyIn", IsRequired=true)>]
member val buyInOrderId:Int32 = new Int32() with get,set
///<summary>
///Richemont POS code
///</summary>
[<ApiMember(Description="Richemont POS code", IsRequired=true)>]
member val posCode:String = null with get,set
///<summary>
///Richemont Reference Code of the item
///</summary>
[<ApiMember(Description="Richemont Reference Code of the item", IsRequired=true)>]
member val articleCode:String = null with get,set
///<summary>
///Serial Number of the item
///</summary>
[<ApiMember(Description="Serial Number of the item")>]
member val serialNumber:String = null with get,set
///<summary>
///Buy-in order status code
///</summary>
[<ApiMember(Description="Buy-in order status code")>]
member val buyInStatusId:String = null with get,set
///<summary>
///Buy-in creation date
///</summary>
[<ApiMember(Description="Buy-in creation date")>]
member val buyInDate:DateTime = new DateTime() with get,set
///<summary>
///Emails of Sale Representatives
///</summary>
[<ApiMember(Description="Emails of Sale Representatives")>]
member val saleRepresentativeEmails:ResizeArray<String> = null with get,set
///<summary>
///True is the buy-in’s piece is in stock, False otherwise
///</summary>
[<ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")>]
member val isInStock:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type GetBuyInPaginatedResponse() =
///<summary>
///Index of the result set returnedr
///</summary>
[<ApiMember(Description="Index of the result set returnedr", 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>
///Total amount of pages / result sets
///</summary>
[<ApiMember(Description="Total amount of pages / result sets", IsRequired=true)>]
member val totalPages:Int32 = new Int32() with get,set
///<summary>
///Total amount of results
///</summary>
[<ApiMember(Description="Total amount of results", IsRequired=true)>]
member val totalResults:Int32 = new Int32() with get,set
///<summary>
///List of Sale Details
///</summary>
[<ApiMember(Description="List of Sale Details", IsRequired=true)>]
member val elements:IEnumerable<BuyIn> = null with get,set
[<AllowNullLiteral>]
type GetBuyInPaginated() =
///<summary>
///Richemont Brand ID
///</summary>
[<ApiMember(Description="Richemont Brand ID")>]
member val brand:String = null with get,set
///<summary>
///Richemont POS code
///</summary>
[<ApiMember(Description="Richemont POS code", IsRequired=true)>]
member val posCode:String = null with get,set
///<summary>
///Richemont Reference Code of the item
///</summary>
[<ApiMember(Description="Richemont Reference Code of the item")>]
member val articleCode:String = null with get,set
///<summary>
///Serial Number of the item
///</summary>
[<ApiMember(Description="Serial Number of the item")>]
member val serialNumber:String = null with get,set
///<summary>
///Buy-in order status code
///</summary>
[<ApiMember(Description="Buy-in order status code")>]
member val buyInStatusId:String = null with get,set
///<summary>
///True is the buy-in’s piece is in stock, False otherwise
///</summary>
[<ApiMember(Description="True is the buy-in’s piece is in stock, False otherwise")>]
member val isInStock:Nullable<Boolean> = new Nullable<Boolean>() 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>
///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>
///Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
///</summary>
[<ApiMember(Description="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")>]
member val sortBy:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /buyin/{brand} HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
page: 0,
items: 0,
totalPages: 0,
totalResults: 0
}