Criação de Produtos
Criando Produtos
Este é o último passo para criação de produtos, onde efetivamente iremos criar os produtos e designá-los para suas categorias e subcategorias.
Repare que ainda é possível atribuir mais informações para controle dos produtos, como estoque, ambientes de produção e demais outras que posteriormente iremos exemplificar. Para isso, você poderá alterar o produto e inserir tais dados. Veja mais em Alteração de Produtos.
Para efetuar a criação de um produto, envie os dados necessários via POST 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.
Criar Produto
POST {Url}/segments/{segmentId}/products
Path Parameters
segmentId
string
ID do Segmento
companies
string
ID's das empresas que serão criadas
Request Body
name*
string
Nome do Produto
price*
string
Preço do Produto
companies
array
ID das empresas que receberão o produto
status
string
Status do produto
(Ativo: active | Inativo: inactive )
sku
string
SKU do produto (ID de manutenção do estoque)
description
string
Descrição do Produto
categoryId
string
ID da Categoria Pai
additionalCategories
array
additionalCategories.name: Nome da Categoria* additionalCategories.systemCode:
ID do código no sistema additionalCategories.minQuantity: Quantidade Mínima additionalCategories.maxQuantity: Quantidade Máxima
additionalsCategories.additionals>*
addtionals.name: Nome do Complemento*
additionals.description: Descrição do Complemento
additionals.systemCode: ID do código no sistema
additionals.price: Preço do Produto additionals.minQuantity: Quantidade Mínima
additionals.maxQuantity: Quantidade Máxima
additional.status: Status do Complemento (Ativo: active | Inativo: inactive )
notPrintToken
string
Não imprimir na etiqueta (Sim: true | Não: false )
unitType
boolean
ID da unidade de medida (UUID)
gtin
string
Número Global de Item Comercial (GTIN)
ncm
string
ID do NCM
cest
string
ID do Cest
taxationRule
string
ID da regra de taxação
productEnvironments
string
ID dos ambientes para controle de produção
pictures
string
URL da imagem (https://subdominio.site.com.br/foto.png)
stockLocals
array
Locais de Estoque: stockLocals.stockLocal: ID do estoque* stockLocals.minQuantity: Quantidade* mínima do produto no local de estoque stockLocals.maxQuantity: Quantidade* máxima do produto no local de estoque
dimensions
array
Dimensões: dimensions.width: Largura do Produto dimensions.height: Altura do Produto dimensions.depth: Profundidade do Produto dimensions.weight: Peso do Produto
salesChannels
array
Configurações dos Canais de Vendas:
salesChannels.company: ID do Negócio*
salesChannels.app: ID do canal de venda*
salesChannels.status: Status da Sincronização*
(Ativo: active | Inativo: inactive )
salesChannels.price: Preço para o Serviço*
brand
string
ID da marca
event
string
Caso o produto seja ingresso de um evento, esse campo deverá ser preenchido com o ID do evento
variations
string
variations.name: Nome da variaçao*
variations.price: Preço da variação*
variations.gtin: Código GTIN da variação
variations.sku: Código SKU da variação
v.dimensions.width: Largura da variação
v.dimensions.height: Altura da variação
v.dimensions.depth: Profundidade da variação
v.variations.weight: Peso da variação
variations.status: Status da variação (Ativo: active | Inativo: inactive )
variations.pictures: URL's de imagem da variação
type
string
ID do tipo do produto
pictures
string
URL's de imagem do produto
suggestions
string
Sugestões para acompanhar o produto quando adicionar
{
"_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": [
{}
]
}Caso a requisição esteja correta, o código 201 Created 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?