Listar Produtos
Listando Produtos
Para listar os produtos criados em nossa plataforma e suas informações, realize a consulta via GET na rota Url/segments/{segmentId}/products.
O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seu Bearer Token também será necessário.
Listar Produtos
GET {Url}/segments/{segmentId}/products
Path Parameters
Name
Type
Description
segmentId
string
ID de Segmento
companies
string
ID de Empresas que listarão os produtos
Query Parameters
Name
Type
Description
name
string
Nome do Produto
companyId
string
ID da empresa
sort
string
Ordenação
page
number
Número da página
limit
number
Limite de registros por página
search
string
Pesquisar por SKU ou nome
type
string
ID do tipo de produto
categoryId
string
ID da categoria ou subcategoria
suggestions
string
Produtos que tenham sugestão
dataSheets
string
Produtos que tenham ficha técnica
packagings
string
Produtos que tenham embalagem
{
"data": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"sku": "string",
"companies": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"type": "private",
"document": "string",
"name": "string",
"tag": "string",
"logoUrl": "string",
"crtId": "string",
"addresses": [
{
"_id": "string",
"country": "string",
"state": "string",
"city": "string",
"neighborhood": "string",
"street": "string",
"number": "string",
"complement": "string",
"postalCode": "string"
}
],
"contacts": [
{
"contact": "string",
"type": "whatsapp"
}
],
"integration": {
"praNotas": {
"authorization": "string",
"homologation": true,
"certificate": "string",
"status": "string",
"count": 0,
"serie": "string",
"csc": "string",
"cscId": "string"
},
"pagaRapido": {
"authorization": "string",
"subscription": "string"
},
"praSaques": {
"token": "string"
}
},
"activityBranch": {
"_id": "string",
"name": "string",
"examples": "string",
"value": "retail"
},
"stockSettings": {
"stockLocalDevice": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
},
"stockLocalCatalog": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
}
}
}
],
"additionalCategories": [
{
"name": "string",
"systemCode": "string",
"minQuantity": 0,
"maxQuantity": 0,
"additionals": [
{
"name": "string",
"description": "string",
"systemCode": "string",
"price": 0,
"minQuantity": 0,
"maxQuantity": 0,
"status": "active"
}
]
}
],
"categoryId": "string",
"category": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"companies": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"type": "private",
"document": "string",
"name": "string",
"tag": "string",
"logoUrl": "string",
"crtId": "string",
"addresses": [
{
"_id": "string",
"country": "string",
"state": "string",
"city": "string",
"neighborhood": "string",
"street": "string",
"number": "string",
"complement": "string",
"postalCode": "string"
}
],
"contacts": [
{
"contact": "string",
"type": "whatsapp"
}
],
"integration": {
"praNotas": {
"authorization": "string",
"homologation": true,
"certificate": "string",
"status": "string",
"count": 0,
"serie": "string",
"csc": "string",
"cscId": "string"
},
"pagaRapido": {
"authorization": "string",
"subscription": "string"
},
"praSaques": {
"token": "string"
}
},
"activityBranch": {
"_id": "string",
"name": "string",
"examples": "string",
"value": "retail"
},
"stockSettings": {
"stockLocalDevice": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
},
"stockLocalCatalog": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
}
}
}
],
"segment": "string",
"name": "string",
"systemCode": "string",
"categoryId": "string",
"iconUrl": "string",
"subcategories": [],
"status": "active",
"salesChannelCategories": [
{
"appConfiguration": {},
"salesChannelCategory": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"externalId": "string",
"name": "string",
"app": "string",
"picture": "string",
"previousCategories": [],
"childrens": [],
"customFields": []
},
"externalId": "string"
}
]
},
"name": "string",
"description": "string",
"images": [
"string"
],
"price": 0,
"printToken": true,
"notPrintToken": true,
"unitType": {
"_id": "string",
"name": "string",
"abbreviation": "string"
},
"gtin": "string",
"ncm": {
"_id": "string",
"code": "string",
"description": "string",
"cestId": "string"
},
"cest": {
"_id": "string",
"name": "string",
"code": "string"
},
"taxationRule": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"segment": "string",
"originId": "string",
"cfopId": "string",
"cstIcmsId": "string",
"cstPisId": "string",
"cstCofinsId": "string",
"cstIpiId": "string",
"cstIssId": "string",
"aliqConfins": 0,
"aliqPis": 0,
"aliquoteCgsn53": 0,
"csll": 0,
"inss": 0,
"ir": 0,
"iss": 0,
"mvaPerState": [
"string"
],
"tributes": [
"string"
],
"status": "active"
},
"productEnvironments": [
"string"
],
"picture": "string",
"status": "active",
"stockLocals": [
{
"_id": "string",
"stockLocal": "string",
"minQuantity": 0,
"maxQuantity": 0
}
],
"dimensions": {
"width": 0,
"height": 0,
"depth": 0,
"weight": 0
},
"salesChannels": [
{
"company": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"type": "private",
"document": "string",
"name": "string",
"tag": "string",
"logoUrl": "string",
"crtId": "string",
"addresses": [
{
"_id": "string",
"country": "string",
"state": "string",
"city": "string",
"neighborhood": "string",
"street": "string",
"number": "string",
"complement": "string",
"postalCode": "string"
}
],
"contacts": [
{
"contact": "string",
"type": "whatsapp"
}
],
"integration": {
"praNotas": {
"authorization": "string",
"homologation": true,
"certificate": "string",
"status": "string",
"count": 0,
"serie": "string",
"csc": "string",
"cscId": "string"
},
"pagaRapido": {
"authorization": "string",
"subscription": "string"
},
"praSaques": {
"token": "string"
}
},
"activityBranch": {
"_id": "string",
"name": "string",
"examples": "string",
"value": "retail"
},
"stockSettings": {
"stockLocalDevice": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
},
"stockLocalCatalog": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"company": null,
"acronym": "string",
"segment": "string"
}
}
},
"app": {},
"status": "active",
"price": 0,
"promotionalPrice": 0
}
],
"pictures": [
"string"
],
"brand": {
"_id": "string",
"name": "string",
"companies": [
{
"_id": "string",
"name": "string"
}
],
"picture": "string",
"status": "active"
},
"stocks": [
{}
]
}
],
"page": 0,
"limit": 0,
"pagesCount": 0
}Caso a requisição esteja correta, o código 200 OK será retornado.
Prossiga para as próximas sessões para entender mais sobre nossas funções disponíveis.
Outros Erros: Caso sejam retornados outros erros, favor entrar em contato com o time de integração.
Last updated
Was this helpful?