GET v1/ShopGroup/{shopGroupId}/Products

Get a list with all available Products, for given shop group.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shopGroupId

The id of the shop group.

integer

Required.

changedAfter

Filter products which are changed after given timestamp.

date

Is Optional.

Default value is (null).

search

Optionally specify a keyword search text. Following fields will be searched: Name, Code, HSCode, EAN.

string

Is Optional.

Default value is (null).

published

Specify to true or false to search in Published products or not.

boolean

Is Optional.

Default value is (null).

pageSize

Size of the page.

integer

Is Optional.

Default value is 1000.

pageNumber

The page number, starting at 1.

integer

Is Optional.

Default value is 1.

Body Parameters

None.

Response Information

Resource Description

A list of the ProductBasicInfo object.


Collection of ProductListItem
NameDescriptionTypeAdditional information
MainImageFileId

Getsthe main image file Id.

integer

None.

QtyAvailable

Gets the qty available.

decimal number

Required

QtyOnHand

Gets the qty on hand.

decimal number

Required

QtyReserved

Gets the qty reserved.

decimal number

Required

KeepStock

When true, inventory management is enabled for the product.

boolean

Required

Published

Gets a value indicating whether this is published.

boolean

Required

WeightKg

Gets or sets the weight.

decimal number

None.

HeightM

Gets the Height of the Product in Meters.

decimal number

None.

LengthM

Gets the Length of the Product in Meters.

decimal number

None.

WidthM

Gets the Width of the Product in Meters.

decimal number

None.

Id

Gets or sets the identifier.

integer

Required

Code

Gets or sets the code.

string

Required

Max length: 100

Name

Gets or sets the name.

string

Max length: 400

Hscode

Gets or sets the Harmonized System Code.

string

Max length: 20

EAN

Gets or sets the European Article Number.

string

Max length: 20

Type

The ProductType, available: SimpleProduct = 0, ProductVariantParent = 1, ProductVariant = 2

integer

None.

ChangedTimestamp

Gets the changed timestamp.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MainImageFileId": 1,
    "QtyAvailable": 1.0,
    "QtyOnHand": 1.0,
    "QtyReserved": 1.0,
    "KeepStock": true,
    "Published": true,
    "WeightKg": 1.0,
    "HeightM": 1.0,
    "LengthM": 1.0,
    "WidthM": 1.0,
    "Id": 3,
    "Code": "sample string 4",
    "Name": "sample string 5",
    "Hscode": "sample string 6",
    "EAN": "sample string 7",
    "Type": 8,
    "ChangedTimestamp": "2021-12-02T20:19:36.7009885+01:00"
  },
  {
    "MainImageFileId": 1,
    "QtyAvailable": 1.0,
    "QtyOnHand": 1.0,
    "QtyReserved": 1.0,
    "KeepStock": true,
    "Published": true,
    "WeightKg": 1.0,
    "HeightM": 1.0,
    "LengthM": 1.0,
    "WidthM": 1.0,
    "Id": 3,
    "Code": "sample string 4",
    "Name": "sample string 5",
    "Hscode": "sample string 6",
    "EAN": "sample string 7",
    "Type": 8,
    "ChangedTimestamp": "2021-12-02T20:19:36.7009885+01:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProductListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductListItem>
    <Id>3</Id>
    <Code>sample string 4</Code>
    <Name>sample string 5</Name>
    <Hscode>sample string 6</Hscode>
    <EAN>sample string 7</EAN>
    <Type>8</Type>
    <ChangedTimestamp>2021-12-02T20:19:36.7009885+01:00</ChangedTimestamp>
    <MainImageFileId>1</MainImageFileId>
    <QtyAvailable>1</QtyAvailable>
    <QtyOnHand>1</QtyOnHand>
    <QtyReserved>1</QtyReserved>
    <KeepStock>true</KeepStock>
    <Published>true</Published>
    <WeightKg>1</WeightKg>
    <HeightM>1</HeightM>
    <LengthM>1</LengthM>
    <WidthM>1</WidthM>
  </ProductListItem>
  <ProductListItem>
    <Id>3</Id>
    <Code>sample string 4</Code>
    <Name>sample string 5</Name>
    <Hscode>sample string 6</Hscode>
    <EAN>sample string 7</EAN>
    <Type>8</Type>
    <ChangedTimestamp>2021-12-02T20:19:36.7009885+01:00</ChangedTimestamp>
    <MainImageFileId>1</MainImageFileId>
    <QtyAvailable>1</QtyAvailable>
    <QtyOnHand>1</QtyOnHand>
    <QtyReserved>1</QtyReserved>
    <KeepStock>true</KeepStock>
    <Published>true</Published>
    <WeightKg>1</WeightKg>
    <HeightM>1</HeightM>
    <LengthM>1</LengthM>
    <WidthM>1</WidthM>
  </ProductListItem>
</ArrayOfProductListItem>