| GET | /purchaseItem/{brand} | Get a list of purchase details |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Purchase.ServiceModel
Namespace Global
Namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel
Public Partial Class Amount
'''<Summary>
'''Value
'''</Summary>
<ApiMember(Description:="Value", IsRequired:=true)>
Public Overridable Property value As Decimal
'''<Summary>
'''Currency
'''</Summary>
<ApiMember(Description:="Currency", IsRequired:=true)>
Public Overridable Property currency As String
End Class
Public Partial Class GetPurchaseItems
Implements IPagedRequest
Public Sub New()
posCodes = New List(Of String)
articleCodes = New List(Of String)
erpOrderCodes = New List(Of String)
End Sub
'''<Summary>
'''Brand
'''</Summary>
<ApiMember(Description:="Brand", IsRequired:=true)>
Public Overridable Property brand As String
'''<Summary>
'''POS Legacy
'''</Summary>
<ApiMember(Description:="POS Legacy", IsRequired:=true)>
Public Overridable Property posCodes As List(Of String)
'''<Summary>
'''Article Codes
'''</Summary>
<ApiMember(Description:="Article Codes")>
Public Overridable Property articleCodes As List(Of String)
'''<Summary>
'''ERP Order Codes
'''</Summary>
<ApiMember(Description:="ERP Order Codes")>
Public Overridable Property erpOrderCodes As List(Of String)
'''<Summary>
'''Index of the result set returned
'''</Summary>
<ApiMember(Description:="Index of the result set returned")>
Public Overridable Property page As Integer
'''<Summary>
'''Size of the result set returned
'''</Summary>
<ApiMember(Description:="Size of the result set returned")>
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>
'''Sorting expression
'''</Summary>
<ApiMember(Description:="Sorting expression")>
Public Overridable Property sortBy As String
End Class
Public Partial Class GetPurchaseItemsResponse
'''<Summary>
'''Total Pages
'''</Summary>
<ApiMember(Description:="Total Pages", IsRequired:=true)>
Public Overridable Property totalPages As Integer
'''<Summary>
'''Total Results
'''</Summary>
<ApiMember(Description:="Total Results", IsRequired:=true)>
Public Overridable Property totalResults As Integer
'''<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>
'''List of purchase items
'''</Summary>
<ApiMember(Description:="List of purchase items", IsRequired:=true)>
Public Overridable Property elements As IEnumerable(Of PurchaseItem)
End Class
Public Partial Class PurchaseItem
'''<Summary>
'''Pos Code
'''</Summary>
<ApiMember(Description:="Pos Code", IsRequired:=true)>
Public Overridable Property posCode As String
'''<Summary>
'''Pos Code To Be Displayed
'''</Summary>
<ApiMember(Description:="Pos Code To Be Displayed", IsRequired:=true)>
Public Overridable Property posCodeToBeDisplayed As String
'''<Summary>
'''Erp Order Id
'''</Summary>
<ApiMember(Description:="Erp Order Id", IsRequired:=true)>
Public Overridable Property erpOrderId As Integer
'''<Summary>
'''Line number
'''</Summary>
<ApiMember(Description:="Line number", IsRequired:=true)>
Public Overridable Property lineNumber As Integer
'''<Summary>
'''Order Date
'''</Summary>
<ApiMember(Description:="Order Date", IsRequired:=true)>
Public Overridable Property orderDate As String
'''<Summary>
'''Origin Order Id
'''</Summary>
<ApiMember(Description:="Origin Order Id")>
Public Overridable Property originOrderId As Nullable(Of Integer)
'''<Summary>
'''Article Code
'''</Summary>
<ApiMember(Description:="Article Code", IsRequired:=true)>
Public Overridable Property articleCode As String
'''<Summary>
'''Ordered Quantity
'''</Summary>
<ApiMember(Description:="Ordered Quantity", IsRequired:=true)>
Public Overridable Property orderedQuantity As Integer
'''<Summary>
'''Open Quantity
'''</Summary>
<ApiMember(Description:="Open Quantity", IsRequired:=true)>
Public Overridable Property openQuantity As Integer
'''<Summary>
'''Order status
'''</Summary>
<ApiMember(Description:="Order status", IsRequired:=true)>
Public Overridable Property status As String
'''<Summary>
'''Net Amount
'''</Summary>
<ApiMember(Description:="Net Amount", IsRequired:=true)>
Public Overridable Property netAmount As Amount
'''<Summary>
'''Customer Reference
'''</Summary>
<ApiMember(Description:="Customer Reference", IsRequired:=true)>
Public Overridable Property customerReference As String
'''<Summary>
'''Speaking Article Code
'''</Summary>
<ApiMember(Description:="Speaking Article Code", IsRequired:=true)>
Public Overridable Property speakingArticleCode As String
'''<Summary>
'''Expected Delivery Date
'''</Summary>
<ApiMember(Description:="Expected Delivery Date", IsRequired:=true)>
Public Overridable Property expectedDeliveryDate As String
'''<Summary>
'''Is Strap Vip Order
'''</Summary>
<ApiMember(Description:="Is Strap Vip Order", IsRequired:=true)>
Public Overridable Property isStrapVipOrder As Boolean
'''<Summary>
'''Order Type
'''</Summary>
<ApiMember(Description:="Order Type", IsRequired:=true)>
Public Overridable Property orderType As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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}