GET v1/Shops/{shopId}/ActiveProductSelectionProducts?onlyPublishedProducts={onlyPublishedProducts}

Get a list with all Products which are available for given Shop.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The ID of the Shop.

 integer

Required.
onlyPublishedProducts

When true, only products which are published are returned, otherwise all.

 boolean

Is Optional.

Default value is False.

Body Parameters

None.

Response Information

Resource Description

A list of the ProductSelectionProductBasicInfo objects

Collection of ProductSelectionProductBasicInfo
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

 integer

Required
Active

Gets or sets a value indicating whether this <see cref="T:ShopCtrl.API.Models.ProductSelectionProductBasicInfo" /> is active.

 boolean

Required
ProductId

Gets or sets the product identifier.

 integer

Required
ProductCode

Gets or sets the product code.

 string

None.
ForeignPriceExVAT

Gets or sets the foreign price (exclude VAT).

 decimal number

Required
ForeignPriceIncVAT

Gets or sets the foreign price (include VAT).

 decimal number

Required
QtyAvailable

Gets or sets the qty available.

 decimal number

Required
QtyOnHand

Gets or sets the qty on hand.

 decimal number

Required
QtyReserved

Gets or sets the qty reserved.

 decimal number

Required

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Active": true,
    "ProductId": 3,
    "ProductCode": "sample string 4",
    "ForeignPriceExVAT": 1.0,
    "ForeignPriceIncVAT": 1.0,
    "QtyAvailable": 5.0,
    "QtyOnHand": 6.0,
    "QtyReserved": 7.0
  },
  {
    "Id": 1,
    "Active": true,
    "ProductId": 3,
    "ProductCode": "sample string 4",
    "ForeignPriceExVAT": 1.0,
    "ForeignPriceIncVAT": 1.0,
    "QtyAvailable": 5.0,
    "QtyOnHand": 6.0,
    "QtyReserved": 7.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfProductSelectionProductBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductSelectionProductBasicInfo>
    <Id>1</Id>
    <Active>true</Active>
    <ProductId>3</ProductId>
    <ProductCode>sample string 4</ProductCode>
    <ForeignPriceExVAT>1</ForeignPriceExVAT>
    <ForeignPriceIncVAT>1</ForeignPriceIncVAT>
    <QtyAvailable>5</QtyAvailable>
    <QtyOnHand>6</QtyOnHand>
    <QtyReserved>7</QtyReserved>
  </ProductSelectionProductBasicInfo>
  <ProductSelectionProductBasicInfo>
    <Id>1</Id>
    <Active>true</Active>
    <ProductId>3</ProductId>
    <ProductCode>sample string 4</ProductCode>
    <ForeignPriceExVAT>1</ForeignPriceExVAT>
    <ForeignPriceIncVAT>1</ForeignPriceIncVAT>
    <QtyAvailable>5</QtyAvailable>
    <QtyOnHand>6</QtyOnHand>
    <QtyReserved>7</QtyReserved>
  </ProductSelectionProductBasicInfo>
</ArrayOfProductSelectionProductBasicInfo>