GET products/productsuppliers?ProductID={ProductID}&WarehouseID={WarehouseID}&IsDefaultSupplierForProduct={IsDefaultSupplierForProduct}&SKU={SKU}&SupplierName={SupplierName}&SupplierID={SupplierID}&SupplierStockLevelMinimum={SupplierStockLevelMinimum}&SupplierStockLevelMaximum={SupplierStockLevelMaximum}&SupplierSKU={SupplierSKU}&PageSize={PageSize}&Page={Page}

This call will return information about Product Suppliers.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ProductID This is an optional parameter. Set it to only return Product Supplier information for the Product matching the supplied Product ID. integer Matching regular expression pattern: ^[1-9]\d*$
WarehouseID This is an optional parameter. Set it to only return Product Supplier information for the given Warehouse. integer Matching regular expression pattern: ^[1-9]\d*$
IsDefaultSupplierForProduct This is an optional parameter. Set this to indicate whether to return only Product Supplier information for Default Suppliers of that product. boolean None.
SKU This is an optional parameter. Set this to only return Product Supplier information for Products with the given SKU. string None.
SupplierName This is an optional parameter. Set this to only return Product Supplier information for a particular Supplier, specified by Supplier Name. string None.
SupplierID This is an optional parameter. Set this to only return Product Supplier information for a particular Supplier, specified by Supplier ID. integer None.
SupplierStockLevelMinimum This is an optional parameter. Set this to only return Product Supplier information where the Supplier Stock level is greater than or equal to the specified amount. integer Matching regular expression pattern: ^[0-9]\d*$
SupplierStockLevelMaximum This is an optional parameter. Set this to only return Product Supplier information where the Supplier Stock level is less than the specified amount. integer Matching regular expression pattern: ^[0-9]\d*$
SupplierSKU This is an optional parameter. Set this it only return Product Supplier information where the Supplier SKU is equal to the provided value. string None.
PageSize This is an optional parameter. This will default to 500. The max page size is 1000 integer Range: inclusive between 1 and 1000
Page This is an optional parameter. This will default to page 1. integer None.

Body Parameters

None.

Response Information

Resource Description

This call will return information about Product Suppliers.

PagedResponseModelOfProductSuppliersModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of ProductSuppliersModel None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalItems": 75,
  "PagingInfo": {
    "MaxPageSize": 100,
    "PageSize": 50,
    "Page": 1
  },
  "TotalPages": 2,
  "Data": [
    {
      "Product": {
        "ProductID": 123,
        "SKU": "Product SKU",
        "WarehouseID": 43
      },
      "Supplier": {
        "SupplierID": 1,
        "SupplierName": "My Supplier",
        "SupplierCurrency": {
          "CurrencyID": 4,
          "CurrencyCode": "GBP",
          "CurrencyName": "British Pound",
          "Symbol": "£"
        }
      },
      "SupplierSKU": "SupplierSKU1",
      "PriorityOrder": 0,
      "IsDefaultSupplierForProduct": true,
      "CostPrice": 5.68,
      "SupplierStockLevel": 100,
      "SupplierCartonQty": 25,
      "SuppliersReference": "Supplier Reference",
      "SupplierMinOrderAmount": 2,
      "NextDeliveryDate": "2024-07-29T00:00:00"
    }
  ]
}

application/xml, text/xml

Sample: 
<PagedProductSuppliersModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>75</TotalItems>
  <PagingInfo>
    <PageSize>50</PageSize>
    <Page>1</Page>
  </PagingInfo>
  <TotalPages>2</TotalPages>
  <Data>
    <ProductSuppliersModel>
      <Product>
        <ProductID>123</ProductID>
        <SKU>Product SKU</SKU>
        <WarehouseID>43</WarehouseID>
      </Product>
      <Supplier>
        <SupplierID>1</SupplierID>
        <SupplierName>My Supplier</SupplierName>
        <SupplierMinOrderAmount xsi:nil="true" />
        <SupplierCurrency>
          <CurrencyID>4</CurrencyID>
          <CurrencyCode>GBP</CurrencyCode>
          <CurrencyName>British Pound</CurrencyName>
          <Symbol>£</Symbol>
        </SupplierCurrency>
      </Supplier>
      <SupplierSKU>SupplierSKU1</SupplierSKU>
      <PriorityOrder>0</PriorityOrder>
      <IsDefaultSupplierForProduct>true</IsDefaultSupplierForProduct>
      <CostPrice>5.68</CostPrice>
      <SupplierStockLevel>100</SupplierStockLevel>
      <SupplierCartonQty>25</SupplierCartonQty>
      <SuppliersReference>Supplier Reference</SuppliersReference>
      <SupplierMinOrderAmount>2</SupplierMinOrderAmount>
      <NextDeliveryDate>2024-07-29T00:00:00</NextDeliveryDate>
    </ProductSuppliersModel>
  </Data>
</PagedProductSuppliersModel>