Richemont.Booster2.PublicApi

<back to all web services

GetStockDetail

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/{posCode}/{articleCode}Get stock details
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

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

        /**
        * Article Code
        */
        @ApiMember(Description="Article Code", IsRequired=true)
        public String articleCode = null;
        
        public String getBrand() { return brand; }
        public GetStockDetail setBrand(String value) { this.brand = value; return this; }
        public String getPosCode() { return posCode; }
        public GetStockDetail setPosCode(String value) { this.posCode = value; return this; }
        public String getArticleCode() { return articleCode; }
        public GetStockDetail setArticleCode(String value) { this.articleCode = value; return this; }
    }

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

        /**
        * Brand
        */
        @ApiMember(Description="Brand", IsRequired=true)
        public String brand = null;

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

        /**
        * Current Stock Quantity
        */
        @ApiMember(Description="Current Stock Quantity", IsRequired=true)
        public Integer currentStockQuantity = null;

        /**
        * Shared Stock Location
        */
        @ApiMember(Description="Shared Stock Location", IsRequired=true)
        public Pos sharedStockLocation = null;

        /**
        * Stock Positions
        */
        @ApiMember(Description="Stock Positions", IsRequired=true)
        public ArrayList<StockPositionItem> stockPositions = null;
        
        public String getArticleCode() { return articleCode; }
        public GetStockDetailResponse setArticleCode(String value) { this.articleCode = value; return this; }
        public String getBrand() { return brand; }
        public GetStockDetailResponse setBrand(String value) { this.brand = value; return this; }
        public String getPosCode() { return posCode; }
        public GetStockDetailResponse setPosCode(String value) { this.posCode = value; return this; }
        public Integer getCurrentStockQuantity() { return currentStockQuantity; }
        public GetStockDetailResponse setCurrentStockQuantity(Integer value) { this.currentStockQuantity = value; return this; }
        public Pos getSharedStockLocation() { return sharedStockLocation; }
        public GetStockDetailResponse setSharedStockLocation(Pos value) { this.sharedStockLocation = value; return this; }
        public ArrayList<StockPositionItem> getStockPositions() { return stockPositions; }
        public GetStockDetailResponse setStockPositions(ArrayList<StockPositionItem> value) { this.stockPositions = value; return this; }
    }

    public static class Pos
    {
        /**
        * Name of the POS
        */
        @ApiMember(Description="Name of the POS", IsRequired=true)
        public String name = null;

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

        /**
        * Pos Code To Be Displayed
        */
        @ApiMember(Description="Pos Code To Be Displayed", IsRequired=true)
        public String posCodeToBeDisplayed = null;

        /**
        * Country of the POS
        */
        @ApiMember(Description="Country of the POS", IsRequired=true)
        public String country = null;

        /**
        * City of the POS
        */
        @ApiMember(Description="City of the POS", IsRequired=true)
        public String city = null;

        /**
        * Postal Code
        */
        @ApiMember(Description="Postal Code", IsRequired=true)
        public String postalCode = null;

        /**
        * State
        */
        @ApiMember(Description="State", IsRequired=true)
        public String state = null;

        /**
        * Street
        */
        @ApiMember(Description="Street", IsRequired=true)
        public String street = null;
        
        public String getName() { return name; }
        public Pos setName(String value) { this.name = value; return this; }
        public String getPosCode() { return posCode; }
        public Pos setPosCode(String value) { this.posCode = value; return this; }
        public String getPosCodeToBeDisplayed() { return posCodeToBeDisplayed; }
        public Pos setPosCodeToBeDisplayed(String value) { this.posCodeToBeDisplayed = value; return this; }
        public String getCountry() { return country; }
        public Pos setCountry(String value) { this.country = value; return this; }
        public String getCity() { return city; }
        public Pos setCity(String value) { this.city = value; return this; }
        public String getPostalCode() { return postalCode; }
        public Pos setPostalCode(String value) { this.postalCode = value; return this; }
        public String getState() { return state; }
        public Pos setState(String value) { this.state = value; return this; }
        public String getStreet() { return street; }
        public Pos setStreet(String value) { this.street = value; return this; }
    }

    public static class StockPositionItem
    {
        /**
        * Quantity
        */
        @ApiMember(Description="Quantity", IsRequired=true)
        public Integer quantity = null;

        /**
        * Serial Number
        */
        @ApiMember(Description="Serial Number")
        public String serialNumber = null;

        /**
        * Stock Date
        */
        @ApiMember(Description="Stock Date", IsRequired=true)
        public String stockDate = null;

        /**
        * Loaded On Date
        */
        @ApiMember(Description="Loaded On Date", IsRequired=true)
        public String loadedOnDate = null;

        /**
        * Type e.g. consignment or standard
        */
        @ApiMember(Description="Type e.g. consignment or standard", IsRequired=true)
        public String type = null;

        /**
        * Is Consignment Sellable 
        */
        @ApiMember(Description="Is Consignment Sellable ", IsRequired=true)
        public Boolean isConsignmentSellable = null;

        /**
        * Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase.
        */
        @ApiMember(Description="Sell-In Price. Disclaimer: this data will be arriving empty/null due to DealerCost project still being in test phase.")
        public UnitNetAmount unitNetAmount = null;

        /**
        * Retail Sales Price
        */
        @ApiMember(Description="Retail Sales Price")
        public UnitNetAmount retailSalesPrice = null;
        
        public Integer getQuantity() { return quantity; }
        public StockPositionItem setQuantity(Integer value) { this.quantity = value; return this; }
        public String getSerialNumber() { return serialNumber; }
        public StockPositionItem setSerialNumber(String value) { this.serialNumber = value; return this; }
        public String getStockDate() { return stockDate; }
        public StockPositionItem setStockDate(String value) { this.stockDate = value; return this; }
        public String getLoadedOnDate() { return loadedOnDate; }
        public StockPositionItem setLoadedOnDate(String value) { this.loadedOnDate = value; return this; }
        public String getType() { return type; }
        public StockPositionItem setType(String value) { this.type = value; return this; }
        public Boolean getIsConsignmentSellable() { return isConsignmentSellable; }
        public StockPositionItem setIsConsignmentSellable(Boolean value) { this.isConsignmentSellable = value; return this; }
        public UnitNetAmount getUnitNetAmount() { return unitNetAmount; }
        public StockPositionItem setUnitNetAmount(UnitNetAmount value) { this.unitNetAmount = value; return this; }
        public UnitNetAmount getRetailSalesPrice() { return retailSalesPrice; }
        public StockPositionItem setRetailSalesPrice(UnitNetAmount value) { this.retailSalesPrice = value; return this; }
    }

    public static class UnitNetAmount
    {
        /**
        * Currency Iso Code
        */
        @ApiMember(Description="Currency Iso Code", IsRequired=true)
        public String currencyIsoCode = null;

        /**
        * Value
        */
        @ApiMember(Description="Value", IsRequired=true)
        public BigDecimal value = null;
        
        public String getCurrencyIsoCode() { return currencyIsoCode; }
        public UnitNetAmount setCurrencyIsoCode(String value) { this.currencyIsoCode = value; return this; }
        public BigDecimal getValue() { return value; }
        public UnitNetAmount setValue(BigDecimal value) { this.value = value; return this; }
    }

}

Java GetStockDetail DTOs

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

HTTP + XML

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

GET /stock/{brand}/{posCode}/{articleCode} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStockDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel">
  <articleCode>String</articleCode>
  <brand>String</brand>
  <currentStockQuantity>0</currentStockQuantity>
  <posCode>String</posCode>
  <sharedStockLocation>
    <city>String</city>
    <country>String</country>
    <name>String</name>
    <posCode>String</posCode>
    <posCodeToBeDisplayed>String</posCodeToBeDisplayed>
    <postalCode>String</postalCode>
    <state>String</state>
    <street>String</street>
  </sharedStockLocation>
  <stockPositions>
    <StockPositionItem>
      <isConsignmentSellable>false</isConsignmentSellable>
      <loadedOnDate>String</loadedOnDate>
      <quantity>0</quantity>
      <retailSalesPrice>
        <currencyIsoCode>String</currencyIsoCode>
        <value>0</value>
      </retailSalesPrice>
      <serialNumber>String</serialNumber>
      <stockDate>String</stockDate>
      <type>String</type>
      <unitNetAmount>
        <currencyIsoCode>String</currencyIsoCode>
        <value>0</value>
      </unitNetAmount>
    </StockPositionItem>
  </stockPositions>
</GetStockDetailResponse>