Enviar lote canônico

PUT

/v1/catalogos/ingestoes/{id}/lotes/{sequencia}

curl --request PUT \
  --url https://api.cotejar.com.br/v1/catalogos/ingestoes/example/lotes/0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "produtos": [ { "codigo_cliente": "example", "descricao_cliente": "example", "ncm": "example", "desativado_por_ato": true, "atributos": [ { "codigo": "example", "valores": [ "example" ] } ] } ] }'

• Produção

Autorizações

• bearerAuth

Parâmetros

Parâmetros de caminho

id

obrigatório

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

sequencia

obrigatório

Qualquer um de:

string

string formato: numeric

0

number

number

>= 1 <= 10000

Parâmetros de cabeçalho

idempotency-key

obrigatório

string

>= 16 caracteres <= 200 caracteres /^\S+$/

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

produtos

obrigatório

Array<object>

>= 1 item <= 200 itens

object

codigo_cliente

string

>= 1 caractere <= 256 caracteres

descricao_cliente

string

>= 1 caractere <= 2000 caracteres

ncm

string

/^[0-9]{8}$/

desativado_por_ato

boolean

atributos

Array<object>

<= 128 itens

object

codigo

obrigatório

string

<= 64 caracteres /^ATT_[0-9]+$/

valores

obrigatório

Array<string>

>= 1 item <= 50 itens

Exemplo^gerado

{
  "produtos": [
    {
      "codigo_cliente": "example",
      "descricao_cliente": "example",
      "ncm": "example",
      "desativado_por_ato": true,
      "atributos": [
        {
          "codigo": "example",
          "valores": [
            "example"
          ]
        }
      ]
    }
  ]
}

Respostas

200

Resposta HTTP 200.

Tipo de mídiaapplication/json

object

ingestao_id

obrigatório

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

sequencia

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 10000

produtos_recebidos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 200

repetido

obrigatório

boolean

Exemplo

{
  "sequencia": 0,
  "produtos_recebidos": 0
}

201

Resposta HTTP 201.

Tipo de mídiaapplication/json

object

ingestao_id

obrigatório

Identificador UUID da ingestão.

string

/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/

sequencia

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 10000

produtos_recebidos

obrigatório

Qualquer um de:

string

string formato: integer

0

integer

integer

>= 1 <= 200

repetido

obrigatório

boolean

Exemplo

{
  "sequencia": 0,
  "produtos_recebidos": 0
}

400

Resposta HTTP 400.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

401

Resposta HTTP 401.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Resposta HTTP 403.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Resposta HTTP 404.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

408

Resposta HTTP 408.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

409

Resposta HTTP 409.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

413

Resposta HTTP 413.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

415

Resposta HTTP 415.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Resposta HTTP 422.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Resposta HTTP 429.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Resposta HTTP 503.

Tipo de mídiaapplication/json

object

erro

obrigatório

object

codigo

obrigatório

string

mensagem

obrigatório

string

request_id

obrigatório

string

caminho

string

Exemplo^gerado

{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}