GET api/{module}/Product/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

module

string

None.

Body Parameters

None.

Response Information

Resource Description

ProductFull
NameDescriptionTypeAdditional information
Image

Collection of byte

None.

BarCode

string

None.

UMCode

string

None.

UMDesc

string

None.

NCMCode

string

None.

NCMDesc

string

None.

GrossWeight

decimal number

None.

NetWeight

decimal number

None.

Tracked

boolean

None.

Attribute1

string

None.

Attribute2

string

None.

Attribute3

string

None.

Attribute4

string

None.

Situation

EProductSituation

None.

SituationDesc

string

None.

BrandCode

string

None.

BrandDesc

string

None.

GroupCode

string

None.

GroupDesc

string

None.

FamilyCode

string

None.

FamilyDesc

string

None.

TypeCode

string

None.

TypeDesc

string

None.

Origin

EProductOrigin

None.

OriginDesc

string

None.

Code

string

None.

Description

string

String length: inclusive between 0 and 120

Id

string

None.

UserTableFields

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
{
  "image": null,
  "barCode": "sample string 1",
  "umCode": "sample string 2",
  "umDesc": "sample string 3",
  "ncmCode": "sample string 4",
  "ncmDesc": "sample string 5",
  "grossWeight": 6.1,
  "netWeight": 7.1,
  "tracked": true,
  "attribute1": "sample string 9",
  "attribute2": "sample string 10",
  "attribute3": "sample string 11",
  "attribute4": "sample string 12",
  "situation": 0,
  "situationDesc": "Ativo",
  "brandCode": "sample string 13",
  "brandDesc": "sample string 14",
  "groupCode": "sample string 15",
  "groupDesc": "sample string 16",
  "familyCode": "sample string 17",
  "familyDesc": "sample string 18",
  "typeCode": "sample string 19",
  "typeDesc": "sample string 20",
  "origin": 0,
  "originDesc": "Nacional - Exceto as indicadas nos códigos 3, 4, 5 e 8",
  "code": "sample string 21",
  "description": "sample string 22",
  "id": "sample string 24",
  "userTableFields": null
}

application/xml, text/xml

Sample:
<ProductFull xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Admin">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common">sample string 24</Id>
  <UserTableFields i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Avant.Plenus.WebApi.Models.Business.Common" />
  <Code>sample string 21</Code>
  <Description>sample string 22</Description>
  <BrandCode>sample string 13</BrandCode>
  <BrandDesc>sample string 14</BrandDesc>
  <FamilyCode>sample string 17</FamilyCode>
  <FamilyDesc>sample string 18</FamilyDesc>
  <GroupCode>sample string 15</GroupCode>
  <GroupDesc>sample string 16</GroupDesc>
  <Origin>National</Origin>
  <Situation>Active</Situation>
  <TypeCode>sample string 19</TypeCode>
  <TypeDesc>sample string 20</TypeDesc>
  <Attribute1>sample string 9</Attribute1>
  <Attribute2>sample string 10</Attribute2>
  <Attribute3>sample string 11</Attribute3>
  <Attribute4>sample string 12</Attribute4>
  <BarCode>sample string 1</BarCode>
  <GrossWeight>6.1</GrossWeight>
  <Image i:nil="true" />
  <NCMCode>sample string 4</NCMCode>
  <NCMDesc>sample string 5</NCMDesc>
  <NetWeight>7.1</NetWeight>
  <Tracked>true</Tracked>
  <UMCode>sample string 2</UMCode>
  <UMDesc>sample string 3</UMDesc>
</ProductFull>