DocCloud API

<back to all web services

GetProductQuery

Requires Authentication
The following routes are available for this service:
GET/product/{Id}Get product by it's id.
GetProductQuery Parameters:
NameParameterData TypeRequiredDescription
IdpathuintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
ProductDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
CodeformstringNo
NettoformdecimalNo
VatTypeIdformintNo
Vat5formdecimalNo
Vat8formdecimalNo
Vat23formdecimalNo
GrossformdecimalNo
UnitIdformuintNo
UnitformstringNo
DefaultQuantityformdecimalNo
PkwiuformstringNo
EanformstringNo
SupplierCodeformstringNo
SellCodeformstringNo
IsActiveformboolNo
StatusformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /product/{Id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Product.Query">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Model" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.GlobalDto.Base">
    <CreatedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</CreatedById>
    <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</CreatedDate>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</Id>
    <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</ModifiedById>
    <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</ModifiedDate>
    <d2p1:Code>String</d2p1:Code>
    <d2p1:DefaultQuantity>0</d2p1:DefaultQuantity>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Ean>String</d2p1:Ean>
    <d2p1:Gross>0</d2p1:Gross>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Netto>0</d2p1:Netto>
    <d2p1:Pkwiu>String</d2p1:Pkwiu>
    <d2p1:SellCode>String</d2p1:SellCode>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:SupplierCode>String</d2p1:SupplierCode>
    <d2p1:Unit>String</d2p1:Unit>
    <d2p1:UnitId>0</d2p1:UnitId>
    <d2p1:Vat23>0</d2p1:Vat23>
    <d2p1:Vat5>0</d2p1:Vat5>
    <d2p1:Vat8>0</d2p1:Vat8>
    <d2p1:VatTypeId>0</d2p1:VatTypeId>
  </Result>
</GetProductResponse>