Skip to content

API para criação/alteração de produtos de forma simplificada.

O endpoint abaixo permite, através de um POST HTTP, criar ou alterar produtos.

Exemplo em cURL

shell
curl 'http://SERVER:PORT/api/product/import' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4' \
-d '{
    "items": [
        {
            "reference":"456789",
            "productGridReference":"45678915"
            "description":"Produto 1",
            "barcode":"0123456789",
            "measureUnit":"KG",
            "size":"M",
            "type":"PRODUCED",
            "color":"Azul",
            "campoCustom1": true,
            "campoCustom2": 123
        }
    ]
}

Obs 1: SERVER é o IP ou DNS do servidor onde o sistema Valesoft está instalado e PORT é a porta definida na instalação.

Obs 2: A chamada para esse endpoint necessita autenticação do tipo Basic(https://swagger.io/docs/specification/authentication/basic-authentication/) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678 => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Definições dos campos do corpo da requisição:

  • items - OBRIGATÓRIO

    • Lista de registros a serem criados/atualizados
  • reference - OBRIGATÓRIO

    • Alfanumérico
    • Código/SKU Único do produto
    • Chave Primaria - Utilizado para criação ou alteração do registro
  • productGridReference

    • Alfanumérico
    • Código/SKU Único da grade do produto
    • Chave Primaria - Utilizado para criação ou alteração do registro
  • description - OBRIGATÓRIO

    • Texto
    • Descrição do produto
  • barcode - OBRIGATÓRIO

    • Numérico Inteiro
    • Código de barras EAN-13 ou um sequencial numérico único do produto, utilizado para a criação da etiqueta EPC no padrão GS1-SGTIN
  • measureUnit

    • Texto
    • Unidade de medida do produto
      • Ex. M², Un, KG
  • size

    • Alfanumérico
    • Código do tamanho do produto
    • Chave Primaria - Utilizado para criação ou alteração do registro
  • productType - OBRIGATÓRIO

    • Texto Predefinido - Maiúsculo
    • Tipo do produto
    • Valores aceitos:
      • RAW - Matéria-prima
      • PRODUCED - Produto acabado
      • CONTAINER - Armazenagem
      • FIXED_ASSET - Ativo Imobilizado
  • color

    • Alfanumérico
    • Descrição da cor do produto
    • Chave Primaria - Utilizado para criação ou alteração do registro
  • campoCustom1 e campoCustom2

    • Quaisquer nomes de campos personalizados desde que os mesmos estejam devidamente configurados nas configurações de campos personalizados do sistema.

Observações

  1. Quando informado o productGridReference a cor e tamanho informados serâo aplicados a grade, caso contrario serão aplicadas ao produto

Resposta em caso de sucesso

Retorna a referência com seu respectivo Identificador interno.

JSON
{
    "items": [
        {
            "reference":"456789",
            "id":"00e80f22-9b9d-44d7-bb57-dbb345b90dec"
        }
    ]
}

Valesoft Sistemas RFID