GET api/v1/Products/{id}?token={token}

Get an existing product from Caspit

Request Information

URI Parameters

NameDescriptionType/Additional information
id

The product's id

string

Required

token

The access token

string

Body Parameters

None.

Response Description

The CaspitProduct

CaspitProduct

A class for a Product

Response Formats

application/json, text/json

Sample:
{
  "ProductId": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "NameEnglish": "sample string 4",
  "DescriptionEnglish": "sample string 5",
  "Comments": "sample string 6",
  "SerialNumber": "sample string 7",
  "CatalogNumber": "sample string 8",
  "SupplierCatalogNumber1": "sample string 9",
  "SupplierCatalogNumber2": "sample string 10",
  "SupplierCatalogNumber3": "sample string 11",
  "Status": true,
  "Warranty": "sample string 13",
  "PurchasePrice": 1.0,
  "SalePrice1": 1.0,
  "SalePrice2": 1.0,
  "SalePrice3": 1.0,
  "SalePrice4": 1.0,
  "ChargeVat": true,
  "CurrencySymbol": "sample string 14",
  "QtyInStock": 1.0,
  "MinQtyInStock": 1.0,
  "MaxQtyInStock": 1.0,
  "UnitName": "sample string 15",
  "Class": "sample string 16",
  "IsPriceIncludeVat": true,
  "DateCreated": "2022-10-06T22:42:07.915973+03:00",
  "UserCreated": "sample string 18",
  "DateUpdated": "2022-10-06T22:42:07.915973+03:00",
  "UserUpdated": "sample string 19"
}

application/xml, text/xml

Sample:
<CaspitProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.caspit.biz/2013/03">
  <DateCreated>2022-10-06T22:42:07.915973+03:00</DateCreated>
  <DateUpdated>2022-10-06T22:42:07.915973+03:00</DateUpdated>
  <UserCreated>sample string 18</UserCreated>
  <UserUpdated>sample string 19</UserUpdated>
  <CatalogNumber>sample string 8</CatalogNumber>
  <ChargeVat>true</ChargeVat>
  <Class>sample string 16</Class>
  <Comments>sample string 6</Comments>
  <CurrencySymbol>sample string 14</CurrencySymbol>
  <Description>sample string 3</Description>
  <DescriptionEnglish>sample string 5</DescriptionEnglish>
  <IsPriceIncludeVat>true</IsPriceIncludeVat>
  <MaxQtyInStock>1</MaxQtyInStock>
  <MinQtyInStock>1</MinQtyInStock>
  <Name>sample string 2</Name>
  <NameEnglish>sample string 4</NameEnglish>
  <ProductId>sample string 1</ProductId>
  <PurchasePrice>1</PurchasePrice>
  <QtyInStock>1</QtyInStock>
  <SalePrice1>1</SalePrice1>
  <SalePrice2>1</SalePrice2>
  <SalePrice3>1</SalePrice3>
  <SalePrice4>1</SalePrice4>
  <SerialNumber>sample string 7</SerialNumber>
  <Status>true</Status>
  <SupplierCatalogNumber1>sample string 9</SupplierCatalogNumber1>
  <SupplierCatalogNumber2>sample string 10</SupplierCatalogNumber2>
  <SupplierCatalogNumber3>sample string 11</SupplierCatalogNumber3>
  <UnitName>sample string 15</UnitName>
  <Warranty>sample string 13</Warranty>
</CaspitProduct>