Criar um produto ou serviço

POSThttps://carchost.fieldcontrol.com.br/products-services

Cria um produto ou um serviço, conforme type. Em contas com o módulo de controle de estoque, um produto pode ser criado já com saldo nos estoques (storageProducts).

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do produto ou serviço.

Até 100 caracteres.

typestring ou numberobrigatório

product ou service. Número ou outro texto resulta em erro 500.

Valores aceitos: product, service.

descriptionstring

Descrição.

Até 2000 caracteres.

measurestringobrigatório

Unidade de medida, obrigatória também para serviços. Valores fora desta lista são gravados como unity. kilogram é gravado, mas volta como null nas respostas.

Valores aceitos: unity, centimeter, meter, liter, milliliter, kilogram.

valuenumberobrigatório

Valor unitário.

archivedbooleanobrigatório

Arquiva o produto ou serviço.

externalobject

Campos de external

idstring

Identificador no seu sistema.

Até 100 caracteres.Aceita: null.

storageProductslista de objetos

Saldo inicial em cada estoque. Só é considerado na criação de produtos (type: product) em contas com o módulo de controle de estoque: a API registra uma movimentação de entrada por item. Ignorado na atualização.

Campos de storageProducts

storageobjectobrigatório

Campos de storage

idstringobrigatório

Identificador do estoque.

quantitynumberobrigatório

Quantidade de entrada.

minimalQuantitynumber

Quantidade mínima do produto no estoque.

Aceita: null.

minimalQuantityAtRisknumber

Quantidade a partir da qual o estoque é considerado em risco.