| GET | /warranty | Get a list of Sale Details | Get a list of Sale Details based on the search parameters submitted |
|---|
namespace Richemont.Booster2.PublicApi.Common.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SaleDetail() =
///<summary>
///Unique Identifier of the Sell-out created in Booster
///</summary>
[<ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)>]
member val saleId:Int32 = new Int32() with get,set
///<summary>
///Unique Identifier of the Sell-out created in Booster
///</summary>
[<ApiMember(Description="Unique Identifier of the Sell-out created in Booster", IsRequired=true)>]
member val saleDetailId:Int32 = new Int32() with get,set
///<summary>
///Booster Customer Id
///</summary>
[<ApiMember(Description="Booster Customer Id")>]
member val boosterCustomerId:Nullable<Int32> = new Nullable<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>
///Receipt or Invoice Number
///</summary>
[<ApiMember(Description="Receipt or Invoice Number")>]
member val documentNumber:String = null with get,set
///<summary>
///Date of the Sell-out
///</summary>
[<ApiMember(Description="Date of the Sell-out", IsRequired=true)>]
member val documentDate:String = null with get,set
///<summary>
///Position Number
///</summary>
[<ApiMember(Description="Position Number")>]
member val documentLineNumber:Nullable<Int32> = new Nullable<Int32>() 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>
///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)>]
member val quantity:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Retail Price
///</summary>
[<ApiMember(Description="Retail Price")>]
member val retailPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
///<summary>
///Sold Price
///</summary>
[<ApiMember(Description="Sold Price")>]
member val unitPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
///<summary>
///Currency of the sold price
///</summary>
[<ApiMember(Description="Currency of the sold price")>]
member val currencyCode:String = null with get,set
///<summary>
///CCP Status Code
///</summary>
[<ApiMember(Description="CCP Status Code")>]
member val ccpStatusCode:String = null with get,set
///<summary>
///CCP Status Description
///</summary>
[<ApiMember(Description="CCP Status Description")>]
member val ccpStatusDescription:String = null with get,set
///<summary>
///CCP Retrigger enable
///</summary>
[<ApiMember(Description="CCP Retrigger enable")>]
member val retriggerEnabled:Boolean = new Boolean() with get,set
///<summary>
///Warranty Extention Status
///</summary>
[<ApiMember(Description="Warranty Extention Status")>]
member val warrantyExtentionStatusId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Warranty Extention Status
///</summary>
[<ApiMember(Description="Warranty Extention Status")>]
member val warrantyExtentionStatusDescription:String = null with get,set
///<summary>
///Sale Representative Email
///</summary>
[<ApiMember(Description="Sale Representative Email")>]
member val saleRepresentativeEmails:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Promoter Type IDs, possible values are: DAI, FIT, GRT
///</summary>
[<ApiMember(Description="Promoter Type IDs, possible values are: DAI, FIT, GRT")>]
member val promoterTypeId:String = null with get,set
///<summary>
///Sellout Type, possible values are: 'standard' or 'consigned'
///</summary>
[<ApiMember(Description="Sellout Type, possible values are: 'standard' or 'consigned'", IsRequired=true)>]
member val type:String = null with get,set
///<summary>
///Original Sale Detail Id
///</summary>
[<ApiMember(Description="Original Sale Detail Id")>]
member val originalSaleDetailId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type GetSaleDetailsResponse() =
///<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<SaleDetail> = null with get,set
[<AllowNullLiteral>]
type ProductCategory() =
///<summary>
///Brand Category ID
///</summary>
[<ApiMember(Description="Brand Category ID")>]
member val brandCategoryId:String = null with get,set
///<summary>
///Grand Category ID
///</summary>
[<ApiMember(Description="Grand Category ID", IsRequired=true)>]
member val grandCategoryId:String = null with get,set
///<summary>
///Master Category ID
///</summary>
[<ApiMember(Description="Master Category ID")>]
member val masterCategoryId:String = null with get,set
///<summary>
///Category ID
///</summary>
[<ApiMember(Description="Category ID")>]
member val categoryId:String = null with get,set
///<summary>
///Sub Category ID
///</summary>
[<ApiMember(Description="Sub Category ID")>]
member val subCategoryId:String = null with get,set
[<AllowNullLiteral>]
type GetSaleDetails() =
///<summary>
///Richemont Brand ID
///</summary>
[<ApiMember(Description="Richemont Brand ID", IsRequired=true)>]
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>
///Receipt or Invoice Number
///</summary>
[<ApiMember(Description="Receipt or Invoice Number")>]
member val documentNumber:String = null with get,set
///<summary>
///Date of the Sell-out Start
///</summary>
[<ApiMember(Description="Date of the Sell-out Start ")>]
member val documentDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Date of the Sell-out End
///</summary>
[<ApiMember(Description="Date of the Sell-out End")>]
member val documentDateTo:Nullable<DateTime> = new Nullable<DateTime>() 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>
///Unique Identifier of the Sell-out created in Booster
///</summary>
[<ApiMember(Description="Unique Identifier of the Sell-out created in Booster")>]
member val saleDetailId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Unique Identifier of the Sell-out created in Booster
///</summary>
[<ApiMember(Description="Unique Identifier of the Sell-out created in Booster")>]
member val saleId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Booster Customer Id
///</summary>
[<ApiMember(Description="Booster Customer Id")>]
member val boosterCustomerId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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)")>]
member val warrantyExtensionStatusIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
///<summary>
///Product Categories
///</summary>
[<ApiMember(Description="Product Categories")>]
member val productCategories:ResizeArray<ProductCategory> = new ResizeArray<ProductCategory>() 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"page":0,"items":0,"totalPages":0,"totalResults":0}