Richemont.Booster2.PublicApi

<back to all web services

GetWarehouseStock

Requires Authentication
The following routes are available for this service:
GET/warehouseItems/{brand}/{posCode}Get a list Paginated Warehouse Stock
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetWarehouseStock implements IPagedRequest
    {
        /**
        * Brand
        */
        @ApiMember(Description="Brand", IsRequired=true)
        public String brand = null;

        /**
        * POS Legacy
        */
        @ApiMember(Description="POS Legacy", IsRequired=true)
        public String posCode = null;

        /**
        * List of Article Codes
        */
        @ApiMember(Description="List of Article Codes")
        public ArrayList<String> articleCodes = null;

        /**
        * Index of the result set returned
        */
        @ApiMember(Description="Index of the result set returned")
        public Integer page = null;

        /**
        * Size of the result set returned
        */
        @ApiMember(Description="Size of the result set returned")
        public Integer items = null;

        /**
        * Omit precise record count - save on performance
        */
        @ApiMember(Description="Omit precise record count - save on performance")
        public Boolean noCount = null;

        /**
        * Sorting expression
        */
        @ApiMember(Description="Sorting expression")
        public String sortBy = null;
        
        public String getBrand() { return brand; }
        public GetWarehouseStock setBrand(String value) { this.brand = value; return this; }
        public String getPosCode() { return posCode; }
        public GetWarehouseStock setPosCode(String value) { this.posCode = value; return this; }
        public ArrayList<String> getArticleCodes() { return articleCodes; }
        public GetWarehouseStock setArticleCodes(ArrayList<String> value) { this.articleCodes = value; return this; }
        public Integer getPage() { return page; }
        public GetWarehouseStock setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetWarehouseStock setItems(Integer value) { this.items = value; return this; }
        public Boolean isNoCount() { return noCount; }
        public GetWarehouseStock setNoCount(Boolean value) { this.noCount = value; return this; }
        public String getSortBy() { return sortBy; }
        public GetWarehouseStock setSortBy(String value) { this.sortBy = value; return this; }
    }

    public static class GetWarehouseStockResponse
    {
        /**
        * Total Pages
        */
        @ApiMember(Description="Total Pages", IsRequired=true)
        public Integer totalPages = null;

        /**
        * Total Results
        */
        @ApiMember(Description="Total Results", IsRequired=true)
        public Integer totalResults = null;

        /**
        * Index of the result set returned
        */
        @ApiMember(Description="Index of the result set returned", IsRequired=true)
        public Integer page = null;

        /**
        * Size of the result set returned
        */
        @ApiMember(Description="Size of the result set returned", IsRequired=true)
        public Integer items = null;

        /**
        * List of movements
        */
        @ApiMember(Description="List of movements", IsRequired=true)
        public ArrayList<WarehouseStockElement> elements = null;
        
        public Integer getTotalPages() { return totalPages; }
        public GetWarehouseStockResponse setTotalPages(Integer value) { this.totalPages = value; return this; }
        public Integer getTotalResults() { return totalResults; }
        public GetWarehouseStockResponse setTotalResults(Integer value) { this.totalResults = value; return this; }
        public Integer getPage() { return page; }
        public GetWarehouseStockResponse setPage(Integer value) { this.page = value; return this; }
        public Integer getItems() { return items; }
        public GetWarehouseStockResponse setItems(Integer value) { this.items = value; return this; }
        public ArrayList<WarehouseStockElement> getElements() { return elements; }
        public GetWarehouseStockResponse setElements(ArrayList<WarehouseStockElement> value) { this.elements = value; return this; }
    }

    public static class WarehouseStockElement
    {
        /**
        * Article Code
        */
        @ApiMember(Description="Article Code", IsRequired=true)
        public String articleCode = null;

        /**
        * Current Stock Quantity
        */
        @ApiMember(Description="Current Stock Quantity", IsRequired=true)
        public Integer atpQuantity = null;
        
        public String getArticleCode() { return articleCode; }
        public WarehouseStockElement setArticleCode(String value) { this.articleCode = value; return this; }
        public Integer getAtpQuantity() { return atpQuantity; }
        public WarehouseStockElement setAtpQuantity(Integer value) { this.atpQuantity = value; return this; }
    }

}

Java GetWarehouseStock DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /warehouseItems/{brand}/{posCode} 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}