| GET | /buyin/{brand} | Get list of buyin | Get list of paginated buyin based on the search parameters submitted |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.CPO.ServiceModel
Namespace Global
Namespace Richemont.Booster2.PublicApi.CPO.ServiceModel
Public Partial Class 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)>
Public Overridable Property brand As String
'''<Summary>
'''Code of BuyIn
'''</Summary>
<ApiMember(Description:="Code of BuyIn", IsRequired:=true)>
Public Overridable Property buyInOrderId As Integer
'''<Summary>
'''Richemont POS code
'''</Summary>
<ApiMember(Description:="Richemont POS code", IsRequired:=true)>
Public Overridable Property posCode As String
'''<Summary>
'''Richemont Reference Code of the item
'''</Summary>
<ApiMember(Description:="Richemont Reference Code of the item", IsRequired:=true)>
Public Overridable Property articleCode As String
'''<Summary>
'''Serial Number of the item
'''</Summary>
<ApiMember(Description:="Serial Number of the item")>
Public Overridable Property serialNumber As String
'''<Summary>
'''Buy-in order status code
'''</Summary>
<ApiMember(Description:="Buy-in order status code")>
Public Overridable Property buyInStatusId As String
'''<Summary>
'''Buy-in creation date
'''</Summary>
<ApiMember(Description:="Buy-in creation date")>
Public Overridable Property buyInDate As Date
'''<Summary>
'''Emails of Sale Representatives
'''</Summary>
<ApiMember(Description:="Emails of Sale Representatives")>
Public Overridable Property saleRepresentativeEmails As List(Of String) = New List(Of String)
'''<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")>
Public Overridable Property isInStock As Boolean
End Class
Public Partial Class GetBuyInPaginated
'''<Summary>
'''Richemont Brand ID
'''</Summary>
<ApiMember(Description:="Richemont Brand ID")>
Public Overridable Property brand As String
'''<Summary>
'''Richemont POS code
'''</Summary>
<ApiMember(Description:="Richemont POS code", IsRequired:=true)>
Public Overridable Property posCode As String
'''<Summary>
'''Richemont Reference Code of the item
'''</Summary>
<ApiMember(Description:="Richemont Reference Code of the item")>
Public Overridable Property articleCode As String
'''<Summary>
'''Serial Number of the item
'''</Summary>
<ApiMember(Description:="Serial Number of the item")>
Public Overridable Property serialNumber As String
'''<Summary>
'''Buy-in order status code
'''</Summary>
<ApiMember(Description:="Buy-in order status code")>
Public Overridable Property buyInStatusId As String
'''<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")>
Public Overridable Property isInStock As Boolean?
'''<Summary>
'''Index of the result set returned
'''</Summary>
<ApiMember(Description:="Index of the result set returned", IsRequired:=true)>
Public Overridable Property page As Integer
'''<Summary>
'''Size of the result set returned
'''</Summary>
<ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
Public Overridable Property items As Integer
'''<Summary>
'''Omit precise record count - save on performance
'''</Summary>
<ApiMember(Description:="Omit precise record count - save on performance")>
Public Overridable Property noCount As Boolean
'''<Summary>
'''Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.
'''</Summary>
<ApiMember(Description:="Sort Expression, Possible values: 'SaleDetailIdDESC', 'DocumentDate'.")>
Public Overridable Property sortBy As String
End Class
Public Partial Class GetBuyInPaginatedResponse
'''<Summary>
'''Index of the result set returnedr
'''</Summary>
<ApiMember(Description:="Index of the result set returnedr", IsRequired:=true)>
Public Overridable Property page As Integer
'''<Summary>
'''Size of the result set returned
'''</Summary>
<ApiMember(Description:="Size of the result set returned", IsRequired:=true)>
Public Overridable Property items As Integer
'''<Summary>
'''Total amount of pages / result sets
'''</Summary>
<ApiMember(Description:="Total amount of pages / result sets", IsRequired:=true)>
Public Overridable Property totalPages As Integer
'''<Summary>
'''Total amount of results
'''</Summary>
<ApiMember(Description:="Total amount of results", IsRequired:=true)>
Public Overridable Property totalResults As Integer
'''<Summary>
'''List of Sale Details
'''</Summary>
<ApiMember(Description:="List of Sale Details", IsRequired:=true)>
Public Overridable Property elements As IEnumerable(Of BuyIn)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}