| GET | /warranty | Get a list of Sale Details | Get a list of Sale Details based on the search parameters submitted |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Richemont.Booster2.PublicApi.Sellout.ServiceModel
Imports Richemont.Booster2.PublicApi.Common.ServiceModel
Namespace Global
Namespace Richemont.Booster2.PublicApi.Common.ServiceModel
Public Partial Class ProductCategory
'''<Summary>
'''Brand Category ID
'''</Summary>
<ApiMember(Description:="Brand Category ID")>
Public Overridable Property brandCategoryId As String
'''<Summary>
'''Grand Category ID
'''</Summary>
<ApiMember(Description:="Grand Category ID", IsRequired:=true)>
Public Overridable Property grandCategoryId As String
'''<Summary>
'''Master Category ID
'''</Summary>
<ApiMember(Description:="Master Category ID")>
Public Overridable Property masterCategoryId As String
'''<Summary>
'''Category ID
'''</Summary>
<ApiMember(Description:="Category ID")>
Public Overridable Property categoryId As String
'''<Summary>
'''Sub Category ID
'''</Summary>
<ApiMember(Description:="Sub Category ID")>
Public Overridable Property subCategoryId As String
End Class
End Namespace
Namespace Richemont.Booster2.PublicApi.Sellout.ServiceModel
Public Partial Class GetSaleDetails
Implements IPagedRequest
Public Sub New()
warrantyExtensionStatusIds = New List(Of Integer)
productCategories = New List(Of ProductCategory)
End Sub
'''<Summary>
'''Richemont Brand ID
'''</Summary>
<ApiMember(Description:="Richemont Brand ID", IsRequired:=true)>
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>
'''Receipt or Invoice Number
'''</Summary>
<ApiMember(Description:="Receipt or Invoice Number")>
Public Overridable Property documentNumber As String
'''<Summary>
'''Date of the Sell-out Start
'''</Summary>
<ApiMember(Description:="Date of the Sell-out Start ")>
Public Overridable Property documentDateFrom As Nullable(Of Date)
'''<Summary>
'''Date of the Sell-out End
'''</Summary>
<ApiMember(Description:="Date of the Sell-out End")>
Public Overridable Property documentDateTo As Nullable(Of Date)
'''<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>
'''Unique Identifier of the Sell-out created in Booster
'''</Summary>
<ApiMember(Description:="Unique Identifier of the Sell-out created in Booster")>
Public Overridable Property saleDetailId As Nullable(Of Integer)
'''<Summary>
'''Unique Identifier of the Sell-out created in Booster
'''</Summary>
<ApiMember(Description:="Unique Identifier of the Sell-out created in Booster")>
Public Overridable Property saleId As Nullable(Of Integer)
'''<Summary>
'''Booster Customer Id
'''</Summary>
<ApiMember(Description:="Booster Customer Id")>
Public Overridable Property boosterCustomerId As Nullable(Of Integer)
'''<Summary>
'''Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)
'''</Summary>
<ApiMember(Description:="Possible warranty extention status IDs, 1 (Activated), 2 (Requested), 3 (Refused), 4 (Error), 5 (Action Required), 6 (Pending)")>
Public Overridable Property warrantyExtensionStatusIds As List(Of Integer)
'''<Summary>
'''Product Categories
'''</Summary>
<ApiMember(Description:="Product Categories")>
Public Overridable Property productCategories As List(Of ProductCategory)
'''<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 GetSaleDetailsResponse
'''<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 SaleDetail)
End Class
Public Partial Class SaleDetail
Public Sub New()
saleRepresentativeEmails = New List(Of String)
End Sub
'''<Summary>
'''Unique Identifier of the Sell-out created in Booster
'''</Summary>
<ApiMember(Description:="Unique Identifier of the Sell-out created in Booster", IsRequired:=true)>
Public Overridable Property saleId As Integer
'''<Summary>
'''Unique Identifier of the Sell-out created in Booster
'''</Summary>
<ApiMember(Description:="Unique Identifier of the Sell-out created in Booster", IsRequired:=true)>
Public Overridable Property saleDetailId As Integer
'''<Summary>
'''Booster Customer Id
'''</Summary>
<ApiMember(Description:="Booster Customer Id")>
Public Overridable Property boosterCustomerId As Nullable(Of Integer)
'''<Summary>
'''Richemont POS code
'''</Summary>
<ApiMember(Description:="Richemont POS code", IsRequired:=true)>
Public Overridable Property posCode As String
'''<Summary>
'''Receipt or Invoice Number
'''</Summary>
<ApiMember(Description:="Receipt or Invoice Number")>
Public Overridable Property documentNumber As String
'''<Summary>
'''Date of the Sell-out
'''</Summary>
<ApiMember(Description:="Date of the Sell-out", IsRequired:=true)>
Public Overridable Property documentDate As String
'''<Summary>
'''Position Number
'''</Summary>
<ApiMember(Description:="Position Number")>
Public Overridable Property documentLineNumber As Nullable(Of Integer)
'''<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>
'''Use positive for standard Sell-out and negative quantity for return
'''</Summary>
<ApiMember(Description:="Use positive for standard Sell-out and negative quantity for return", IsRequired:=true)>
Public Overridable Property quantity As Nullable(Of Integer)
'''<Summary>
'''Retail Price
'''</Summary>
<ApiMember(Description:="Retail Price")>
Public Overridable Property retailPrice As Nullable(Of Decimal)
'''<Summary>
'''Sold Price
'''</Summary>
<ApiMember(Description:="Sold Price")>
Public Overridable Property unitPrice As Nullable(Of Decimal)
'''<Summary>
'''Currency of the sold price
'''</Summary>
<ApiMember(Description:="Currency of the sold price")>
Public Overridable Property currencyCode As String
'''<Summary>
'''CCP Status Code
'''</Summary>
<ApiMember(Description:="CCP Status Code")>
Public Overridable Property ccpStatusCode As String
'''<Summary>
'''CCP Status Description
'''</Summary>
<ApiMember(Description:="CCP Status Description")>
Public Overridable Property ccpStatusDescription As String
'''<Summary>
'''CCP Retrigger enable
'''</Summary>
<ApiMember(Description:="CCP Retrigger enable")>
Public Overridable Property retriggerEnabled As Boolean
'''<Summary>
'''Warranty Extention Status
'''</Summary>
<ApiMember(Description:="Warranty Extention Status")>
Public Overridable Property warrantyExtentionStatusId As Nullable(Of Integer)
'''<Summary>
'''Warranty Extention Status
'''</Summary>
<ApiMember(Description:="Warranty Extention Status")>
Public Overridable Property warrantyExtentionStatusDescription As String
'''<Summary>
'''Sale Representative Email
'''</Summary>
<ApiMember(Description:="Sale Representative Email")>
Public Overridable Property saleRepresentativeEmails As List(Of String)
'''<Summary>
'''Promoter Type IDs, possible values are: DAI, FIT, GRT
'''</Summary>
<ApiMember(Description:="Promoter Type IDs, possible values are: DAI, FIT, GRT")>
Public Overridable Property promoterTypeId As String
'''<Summary>
'''Sellout Type, possible values are: 'standard' or 'consigned'
'''</Summary>
<ApiMember(Description:="Sellout Type, possible values are: 'standard' or 'consigned'", IsRequired:=true)>
Public Overridable Property type As String
'''<Summary>
'''Original Sale Detail Id
'''</Summary>
<ApiMember(Description:="Original Sale Detail Id")>
Public Overridable Property originalSaleDetailId As Nullable(Of Integer)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /warranty HTTP/1.1 Host: dev-api-booster.richemont.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}