Richemont.Booster2.PublicApi

<back to all web services

GetPurchaseItems

Requires Authentication
The following routes are available for this service:
GET/purchaseItem/{brand}Get a list of purchase details
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.Purchase.ServiceModel;

namespace Richemont.Booster2.PublicApi.Purchase.ServiceModel
{
    public partial class Amount
    {
        ///<summary>
        ///Value
        ///</summary>
        [ApiMember(Description="Value", IsRequired=true)]
        public virtual decimal value { get; set; }

        ///<summary>
        ///Currency
        ///</summary>
        [ApiMember(Description="Currency", IsRequired=true)]
        public virtual string currency { get; set; }
    }

    public partial class GetPurchaseItems
        : IPagedRequest
    {
        public GetPurchaseItems()
        {
            posCodes = new List<string>{};
            articleCodes = new List<string>{};
            erpOrderCodes = new List<string>{};
        }

        ///<summary>
        ///Brand
        ///</summary>
        [ApiMember(Description="Brand", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///POS Legacy
        ///</summary>
        [ApiMember(Description="POS Legacy", IsRequired=true)]
        public virtual List<string> posCodes { get; set; }

        ///<summary>
        ///Article Codes
        ///</summary>
        [ApiMember(Description="Article Codes")]
        public virtual List<string> articleCodes { get; set; }

        ///<summary>
        ///ERP Order Codes
        ///</summary>
        [ApiMember(Description="ERP Order Codes")]
        public virtual List<string> erpOrderCodes { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned")]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned")]
        public virtual int items { get; set; }

        ///<summary>
        ///Omit precise record count - save on performance
        ///</summary>
        [ApiMember(Description="Omit precise record count - save on performance")]
        public virtual bool noCount { get; set; }

        ///<summary>
        ///Sorting expression
        ///</summary>
        [ApiMember(Description="Sorting expression")]
        public virtual string sortBy { get; set; }
    }

    public partial class GetPurchaseItemsResponse
    {
        ///<summary>
        ///Total Pages
        ///</summary>
        [ApiMember(Description="Total Pages", IsRequired=true)]
        public virtual int totalPages { get; set; }

        ///<summary>
        ///Total Results
        ///</summary>
        [ApiMember(Description="Total Results", IsRequired=true)]
        public virtual int totalResults { get; set; }

        ///<summary>
        ///Index of the result set returned
        ///</summary>
        [ApiMember(Description="Index of the result set returned", IsRequired=true)]
        public virtual int page { get; set; }

        ///<summary>
        ///Size of the result set returned
        ///</summary>
        [ApiMember(Description="Size of the result set returned", IsRequired=true)]
        public virtual int items { get; set; }

        ///<summary>
        ///List of purchase items
        ///</summary>
        [ApiMember(Description="List of purchase items", IsRequired=true)]
        public virtual IEnumerable<PurchaseItem> elements { get; set; }
    }

    public partial class PurchaseItem
    {
        ///<summary>
        ///Pos Code
        ///</summary>
        [ApiMember(Description="Pos Code", IsRequired=true)]
        public virtual string posCode { get; set; }

        ///<summary>
        ///Pos Code To Be Displayed
        ///</summary>
        [ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)]
        public virtual string posCodeToBeDisplayed { get; set; }

        ///<summary>
        ///Erp Order Id
        ///</summary>
        [ApiMember(Description="Erp Order Id", IsRequired=true)]
        public virtual int erpOrderId { get; set; }

        ///<summary>
        ///Line number
        ///</summary>
        [ApiMember(Description="Line number", IsRequired=true)]
        public virtual int lineNumber { get; set; }

        ///<summary>
        ///Order Date
        ///</summary>
        [ApiMember(Description="Order Date", IsRequired=true)]
        public virtual string orderDate { get; set; }

        ///<summary>
        ///Origin Order Id
        ///</summary>
        [ApiMember(Description="Origin Order Id")]
        public virtual int? originOrderId { get; set; }

        ///<summary>
        ///Article Code
        ///</summary>
        [ApiMember(Description="Article Code", IsRequired=true)]
        public virtual string articleCode { get; set; }

        ///<summary>
        ///Ordered Quantity
        ///</summary>
        [ApiMember(Description="Ordered Quantity", IsRequired=true)]
        public virtual int orderedQuantity { get; set; }

        ///<summary>
        ///Open Quantity
        ///</summary>
        [ApiMember(Description="Open Quantity", IsRequired=true)]
        public virtual int openQuantity { get; set; }

        ///<summary>
        ///Order status
        ///</summary>
        [ApiMember(Description="Order status", IsRequired=true)]
        public virtual string status { get; set; }

        ///<summary>
        ///Net Amount
        ///</summary>
        [ApiMember(Description="Net Amount", IsRequired=true)]
        public virtual Amount netAmount { get; set; }

        ///<summary>
        ///Customer Reference
        ///</summary>
        [ApiMember(Description="Customer Reference", IsRequired=true)]
        public virtual string customerReference { get; set; }

        ///<summary>
        ///Speaking Article Code
        ///</summary>
        [ApiMember(Description="Speaking Article Code", IsRequired=true)]
        public virtual string speakingArticleCode { get; set; }

        ///<summary>
        ///Expected Delivery Date
        ///</summary>
        [ApiMember(Description="Expected Delivery Date", IsRequired=true)]
        public virtual string expectedDeliveryDate { get; set; }

        ///<summary>
        ///Is Strap Vip Order
        ///</summary>
        [ApiMember(Description="Is Strap Vip Order", IsRequired=true)]
        public virtual bool isStrapVipOrder { get; set; }

        ///<summary>
        ///Order Type
        ///</summary>
        [ApiMember(Description="Order Type", IsRequired=true)]
        public virtual string orderType { get; set; }
    }

}

C# GetPurchaseItems DTOs

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

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"totalPages":0,"totalResults":0,"page":0,"items":0}