Get the product summary

Returns the ID, code, name, barcode and status of every product in a source in one response.

POST https://out.stockmount.com/api/Product/GetProductSummary

Product package required

There is no paging or filtering; all products in the source come in one response, in no guaranteed order. Only ProductSourceId is read; the GetProducts filter and paging fields are ignored.

TotalProductCount and FilteredProductCount are always equal to the number of returned products. Products deleted with the retired DeleteProduct are not returned; stopped products (status 3) are. Use this call to map products in your system to StockMount ProductId values.

Accounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.

Request fields

Field	Type	Description
`ApiCode` required	string	Session code returned by `DoLogin`.
`ProductSourceId` required	integer	Source ID. A value below 1 returns 00003 (`ErrorMessage`: `ProductSourceId`).

Response fields (Response)

Field	Type	Description
`TotalProductCount`	integer	Number of returned products.
`FilteredProductCount`	integer	Same as `TotalProductCount`.
`Products`	object[]	All products in the source.
Products[]. `ProductId`	integer	Product ID.
Products[]. `ProductSourceId`	integer	Source ID.
Products[]. `Code`	string	Product code.
Products[]. `Name`	string	Product name.
Products[]. `Barcode`	string	Barcode; empty string if none.
Products[]. `Status`	integer	Product status. `0` Not changed `1` New (initial status of products added through the API) `2` Changed (after `UpdateProduct` when stock is above 0) `3` Stopped / out of stock (`StopProduct`, or stock below 1) `4` Re-added

Error codes for this endpoint

Code	When
`70018`	Your account has no active Product package (`ErrorMessage` is Turkish: `Ürün entegrasyonu için aktif Ürün Paketi gereklidir.`).
`99999`	An unexpected error occurred.

For session errors (00001, 00006) and every other code see error codes.

Related endpoints

Example request

{
  "ApiCode": "API_CODE",
  "ProductSourceId": 1234
}

curl -X POST 'https://out.stockmount.com/api/Product/GetProductSummary' \
  -H 'Content-Type: application/json' \
  -d '{
  "ApiCode": "API_CODE",
  "ProductSourceId": 1234
}'

using System.Net.Http;
using System.Text;

using var http = new HttpClient();
var json = """
{
  "ApiCode": "API_CODE",
  "ProductSourceId": 1234
}
""";

var response = await http.PostAsync(
    "https://out.stockmount.com/api/Product/GetProductSummary",
    new StringContent(json, Encoding.UTF8, "application/json"));

var result = await response.Content.ReadAsStringAsync();
// Result == false ise ErrorCode ve ErrorMessage alanlarına bakın.
Console.WriteLine(result);

<?php
$body = <<<'JSON'
{
  "ApiCode": "API_CODE",
  "ProductSourceId": 1234
}
JSON;

$ch = curl_init('https://out.stockmount.com/api/Product/GetProductSummary');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (!$result['Result']) {
    echo $result['ErrorCode'] . ' ' . $result['ErrorMessage'];
}

import requests

payload = {
    "ApiCode": "API_CODE",
    "ProductSourceId": 1234
}

response = requests.post("https://out.stockmount.com/api/Product/GetProductSummary", json=payload, timeout=60)
result = response.json()

if not result["Result"]:
    print(result["ErrorCode"], result["ErrorMessage"])

const payload = {
  "ApiCode": "API_CODE",
  "ProductSourceId": 1234
};

const response = await fetch("https://out.stockmount.com/api/Product/GetProductSummary", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
const result = await response.json();

if (!result.Result) {
  console.error(result.ErrorCode, result.ErrorMessage);
}

Example response

{
  "Result": true,
  "Response": {
    "TotalProductCount": 2,
    "FilteredProductCount": 2,
    "Products": [
      {
        "ProductId": 987654,
        "ProductSourceId": 1234,
        "Code": "TSHIRT-001",
        "Name": "Basic Pamuklu Tişört",
        "Barcode": "8690000000017",
        "Status": 2
      },
      {
        "ProductId": 987655,
        "ProductSourceId": 1234,
        "Code": "PANT-002",
        "Name": "Chino Pantolon",
        "Barcode": "8690000000048",
        "Status": 3
      }
    ]
  }
}

Try it

The request goes straight from your browser to out.stockmount.com. The ApiCode is not stored by this site; it is kept only while this tab is open.

Get an ApiCode before sending requests.

Body (JSON)

{
  "ApiCode": "{{apiCode}}",
  "ProductSourceId": 1234
}