rev5-2026-05-15 Protheus 12.1.33

ComplementoProduto

CRUD do complemento de produto (tabela SB5) via MsExecAuto de MATA180. Relação 1:1 com SB1 — o complemento existe sempre amarrado a um produto já cadastrado. O identificador externo é B5_COD (o mesmo código do produto, validado contra SB1 em todas as operações de escrita).

Vinculação com o ERP

Tabela mestre SB5 Complemento de produto (1:1 com SB1)

Rotina automática MATA180 MsExecAuto

Wrapper AdvPL U_MT180Exc src/lib/MAT/MT180EXC.prw

Operações & modos

POST modo 3 PUT modo 4 DEL modo 5

Dependências de ambiente

Cadastro · obrigatório

Produto (SB1)

o produto referenciado em {cod} precisa existir em SB1 · pré-check com DbSeek(xFilial("SB1") + cod)
ausência retorna 422 com "Produto X nao encontrado em SB1"

Cadastro · estado de bloqueio

Complemento (SB5)

campos B5_MSBLQL + B5_MSBLQD
B5_MSBLQL pertence("12") · "1"=Inativo (bloqueado), "2"=Ativo (default)

Unicidade

Relação 1:1 SB1↔SB5

cada produto tem no máximo um complemento · POST em produto que já tem complemento retorna 409
para alterar use PUT · sem GetSXENum (a chave é o próprio B1_COD)

Convenções

Identificador externo. Todas as rotas /WsComplementoProduto/{cod} esperam o código do produto (B1_COD / B5_COD) — o complemento é 1:1 com SB1 e não tem chave própria. O endpoint normaliza o valor com PadR no tamanho do SX3 antes do DbSeek; o cliente pode passar trimado.

Pré-condição de produto (POST/PUT). Antes de qualquer MsExecAuto, o endpoint valida que SB1 tem o produto. Produto inexistente retorna 422 com mensagem "Produto X nao encontrado em SB1". Crie o produto via CadastroProduto antes de complementar.

Unicidade 1:1. POST em produto que já tem complemento retorna 409. Para alterar campos do complemento, use PUT. Para zerar e recriar, sequencie DELETE + POST.

Bloqueio TOTVS (B5_MSBLQL / B5_MSBLQD). Em registro bloqueado, o PUT só aceita payload que toque exclusivamente os campos de bloqueio (caminho de desbloqueio); qualquer outro campo retorna 422 com motivo explícito. B5_MSBLQL="1" é Inativo, "2" é Ativo (default SX3). B5_MSBLQD compara contra dDataBase — registro fica bloqueado enquanto dDataBase > B5_MSBLQD.

Formato de datas. B5_MSBLQD no payload aceita string ISO YYYY-MM-DD ou string vazia (limpa a data); conversão interna usa sToD(StrTran(…, "-", "")). No GET o campo ainda não é serializado — CAMPOS_GET exclui B5_MSBLQD até que U_RestMontaRegistro tenha o serializador Date-aware (tarefa transversal).

Paginação e delta-sync. /_list usa page/pageSize (default 50, máx 500). Para sincronização incremental, alterne para orderBy=recno e use cursor conforme o nextCursor retornado.

Campos opcionais do SB5. Nem toda empresa expõe todos os campos do dicionário (B5_CEMETIN, B5_AUTOFAB, B5_USOPRO, etc). O endpoint usa fCpsAtv (FieldPos > 0) para filtrar a lista antes de chamar U_RestMontaRegistro; fProcCrud também consulta GetSx3Cache e pula campos sem definição.

Complemento

CRUD por código de produto

GET /WsComplementoProduto/{cod} Consulta complemento por código do produto

Descrição

Retorna o complemento pesquisado pelo código do produto. Aplica filtro de filial (xFilial("SB5")) e respeita o whitelist CAMPOS_GET filtrado por FieldPos > 0 — em empresas que não têm um campo opcional, ele simplesmente não aparece no retorno.

Path parameter

cod string · path · obrigatório SB5.B5_COD

Código do produto (B1_COD). Será preenchido à direita com espaços até TamSX3("B5_COD")[1].

Query parameters

fields string · query · opcional

Lista de campos separados por vírgula, validados contra CAMPOS_GET.

Cenarios

Exemplo da requisicao (cenario ativo)

Consulta direta — sem fields; retorna whitelist completo de CAMPOS_GET.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Consulta com fields — reduz payload de retorno via fields=.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001?fields=B5_COD,B5_CEME,B5_GARANT
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Complemento encontrado. Envelope { success: true, data: Complemento }.

400

Código ausente no path. Tier: validation-error.

404

Complemento inexistente para o produto. Tier: not-found.

500

Erro interno (DbSeek, serialização). Tier: business-error.

POST /WsComplementoProduto/{cod} Inclui complemento

Descrição

Inclui um complemento via MATA180 em modo 3 (MODEL_OPERATION_INSERT). A chave do complemento é o próprio B5_COD = B1_COD — não há GetSXENum; o produto precisa existir previamente em SB1 (pré-check obrigatório).

Whitelist de campos: ver ComplementoPayload.
Relação 1:1 — se já existir complemento para o produto, retorna 409.

Path parameter

cod string · path · obrigatório SB5.B5_COD

Código do produto existente em SB1.

Request body

application/json ComplementoPayload · obrigatório

Payload plano com campos do whitelist CAMPOS_ALLOW. Schema completo em ComplementoPayload.

Payload mínimo — campos descritivos básicos. Fixture: fixtures/post-valid.json.

RequestHTTP/1.1 · application/json

POST https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_CEME": "TESTE_REST descricao tecnica complementar do produto",
  "B5_OBSERV": "TESTE_REST observacao gerada pelo smoke test",
  "B5_USOPRO": "Uso interno - TESTE_REST",
  "B5_GARANT": "12 meses"
}

Payload completo — todos os campos descritivos do SB5, incluindo descrição em inglês e indicadores de auto-fabricação / fórmula.

RequestHTTP/1.1 · application/json

POST https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_CEME": "Descricao tecnica completa do produto PA001",
  "B5_CEMETIN": "Full technical description of product PA001",
  "B5_OBSERV": "Observacoes operacionais e de manuseio",
  "B5_CARACT": "Caracteristicas fisico-quimicas",
  "B5_FORMUL": "Formulacao registrada",
  "B5_AUTOFAB": "N",
  "B5_USOPRO": "Producao interna",
  "B5_GARANT": "24 meses",
  "B5_PESO": 1.25,
  "B5_TOTGOR": 5.4,
  "B5_TOTGORS": 2.1,
  "B5_TOTGORT": 0.3,
  "B5_COR": "VERMELHO",
  "B5_ALTURA": 12.5,
  "B5_MODELO": "MOD-2026-A",
  "B5_MARCA": "Marca Comercial Exemplo"
}

Respostas

201

Complemento incluído. Envelope CrudResponse com data = ComplementoRef (filial + cod + ids técnicos).

400

Body JSON vazio, JSON inválido ou path sem cod. Tier: validation-error.

409

Já existe complemento para o produto (relação 1:1 violada). Tier: business-error.

422

Produto não encontrado em SB1 ou MsExecAuto do MATA180 rejeitou o payload. Tier: business-error.

500

Erro interno.

PUT /WsComplementoProduto/{cod} Altera complemento existente

Descrição

Altera campos do complemento via MATA180 em modo 4 (MODEL_OPERATION_UPDATE). Aceita qualquer subconjunto do whitelist CAMPOS_ALLOW.

Bloqueio TOTVS. Em registro bloqueado por B5_MSBLQL="1" ou dDataBase > B5_MSBLQD, o PUT retorna 422 a menos que o payload toque exclusivamente B5_MSBLQL/B5_MSBLQD (caminho de desbloqueio).

B5_MSBLQL: "1" = Inativo, "2" = Ativo (default).
B5_MSBLQD: string ISO YYYY-MM-DD ou vazia (limpa).

Path parameter

cod string · path · obrigatório SB5.B5_COD

Código do produto cujo complemento será alterado.

Request body

application/json ComplementoPayload · obrigatório

Subconjunto do whitelist. Em complemento bloqueado, ver convenções.

Alteração comum — atualiza descrição técnica e garantia sem mexer no bloqueio. Fixture: fixtures/put-update.json.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_CEME": "TESTE_REST descricao ALTERADA pelo PUT",
  "B5_OBSERV": "TESTE_REST observacao ALTERADA pelo smoke test",
  "B5_GARANT": "24 meses"
}

Liberar registro bloqueado — caminho de desbloqueio. Em complemento bloqueado, esse é um dos dois únicos payloads aceitos. Qualquer campo fora do par B5_MSBLQL/B5_MSBLQD provoca 422.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_MSBLQL": "2"
}

Bloqueio manual com vigência futura — define B5_MSBLQL="1" (Inativo) e B5_MSBLQD no futuro. O MsExecAuto interpreta a data como vigência.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_MSBLQL": "1",
  "B5_MSBLQD": "2026-12-31"
}

Limpa data de bloqueio — passa B5_MSBLQD="" para zerar a data. Combinável com mudança de B5_MSBLQL no mesmo payload.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "B5_MSBLQL": "2",
  "B5_MSBLQD": ""
}

Respostas

200

Complemento alterado. Envelope CrudResponse.

400

Body inválido ou path sem cod. Tier: validation-error.

404

Complemento inexistente para o produto. Tier: not-found.

422

Validação de payload (MsExecAuto do MATA180) ou registro bloqueado com payload tocando campos fora do par B5_MSBLQL/B5_MSBLQD. Tier: business-error.

500

Erro interno.

DEL /WsComplementoProduto/{cod} Exclui complemento

Descrição

Exclui o complemento via MATA180 em modo 5 (MODEL_OPERATION_DELETE). O SB1 não é tocado — só o registro do SB5 é removido. MsExecAuto do MATA180 rejeita exclusão em registro bloqueado pelo par B5_MSBLQL/B5_MSBLQD.

Path parameter

cod string · path · obrigatório SB5.B5_COD

Código do produto cujo complemento será removido.

Cenario

Exemplo da requisicao (cenario ativo)

Exclusao direta — chama MATA180 op=5. Falha 422 em complemento bloqueado.

RequestHTTP/1.1 · sem body

DELETE https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/PA001
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Complemento excluído. Envelope CrudResponse.

400

Path sem cod. Tier: validation-error.

404

Complemento inexistente. Tier: not-found.

422

Complemento bloqueado ou rejeitado pelo MsExecAuto do MATA180. Tier: business-error.

500

Erro interno.

GET /WsComplementoProduto/_byid Consulta complemento por id técnico (recno|msuid)

Descrição

Busca o complemento por id técnico — útil para integrações que persistem a chave interna (recno) ou o identificador universal (msuid) e querem reconfirmar o registro sem reconstruir o código do produto.

Query parameters

tipo string · query · obrigatório

Indica qual id técnico está sendo usado.

recnomsuid

valor string · query · obrigatório

Valor do id (inteiro positivo quando tipo=recno, string quando tipo=msuid).

Cenarios

Exemplo da requisicao (cenario ativo)

Por RecNo — caminho recomendado.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/_byid?tipo=recno&valor=1234
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Por MSUID — retorna 501 caso SB5 nao exponha B5_MSUID no SX3.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/_byid?tipo=msuid&valor=9f7a3e2c4b8d1a0e
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Complemento encontrado. Envelope { success: true, data: Complemento }.

400

Parâmetros tipo/valor ausentes ou tipo fora do enum.

404

Complemento não localizado. Tier: not-found.

501

Busca por msuid requer o campo B5_MSUID presente neste ambiente.

500

Erro interno.

Listagem

Listagem paginada com delta-sync

GET /WsComplementoProduto/_list Lista complementos com filtros e paginação

Descrição

Lista complementos com filtro opcional por cod. Suporta dois modos de ordenação:

orderBy=chave (default) — paginação por page/pageSize sobre o índice 1 (B5_FILIAL+B5_COD).
orderBy=recno — delta-sync keyset; use cursor com o nextCursor retornado para avançar.

Não há endpoint _search dedicado — o complemento é identificado pelo próprio código do produto, então a busca por texto/typeahead vive em CadastroProduto (B1_DESC).

Query parameters

cod string · query · opcional SB5.B5_COD

Filtra pelo código do produto (match exato após PadR).

fields string · query · opcional

Lista de campos validados contra CAMPOS_GET.

page integer · query · opcional

Página (default 1, mínimo 1). Válido apenas com orderBy=chave.

pageSize integer · query · opcional

Tamanho da página (default 50, máx 500).

orderBy string · query · opcional

Modo de ordenação. Default chave.

chaverecno

since integer · query · opcional

RecNo mínimo a considerar (válido com orderBy=chave para delta-sync simplificado).

cursor integer · query · opcional

Cursor retornado em nextCursor de página anterior (modo recno).

Cenarios

Exemplo da requisicao (cenario ativo)

Paginacao por chave — modo default orderBy=chave com page/pageSize.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/_list?page=1&pageSize=50
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Delta-sync por RecNo — sincronizacao incremental; cliente itera via nextCursor ate vazio.

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsComplementoProduto/_list?orderBy=recno&cursor=0&pageSize=200
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Página de complementos. Envelope com data (array de Complemento), orderBy, pageSize, count, page (chave) ou nextCursor (recno).

400

Parâmetro fora do domínio (ex: fields com campo não permitido).

500

Erro interno.

Schemas

Definições canônicas — campos com origem SX3 rastreável

Complemento

object

Representação retornada nos GETs (/{cod}, /_list, /_byid). Inclui filial, chave (B5_COD), campos descritivos e flag de bloqueio. B5_MSBLQD ainda não é serializado (Date pendente em U_RestMontaRegistro). Campos efetivamente retornados dependem de CAMPOS_GET filtrado por FieldPos > 0 e do parâmetro fields.

B5_FILIALstring · opcionalSB5.B5_FILIAL

Filial do registro (compartilhamento conforme SX2).

B5_CODstring · opcionalSB5.B5_COD

Código do produto (igual a SB1.B1_COD).

B5_CEMEstring · opcionalSB5.B5_CEME

Descrição técnica / complementar (Memo).

B5_CEMETINstring · opcionalSB5.B5_CEMETIN

Descrição em inglês (Memo). Disponível conforme dicionário da empresa.

B5_OBSERVstring · opcionalSB5.B5_OBSERV

Observações livres (Memo).

B5_CARACTstring · opcionalSB5.B5_CARACT

Características físico-químicas (Memo).

B5_FORMULstring · opcionalSB5.B5_FORMUL

Fórmula / receita (Memo).

B5_AUTOFABstring · opcionalSB5.B5_AUTOFAB

Indicador de auto-fabricação.

B5_USOPROstring · opcionalSB5.B5_USOPRO

Uso / aplicação do produto.

B5_GARANTstring · opcionalSB5.B5_GARANT

Garantia (texto livre, ex: "24 meses").

B5_MSBLQLstring · opcionalSB5.B5_MSBLQL

Flag de bloqueio TOTVS-padrão. SX3 pertence("12"), default "2". "1"=Inativo (bloqueado), "2"=Ativo.

12

B5_PESOnumber · opcionalSB5.B5_PESO

Peso do produto (kg). Numérico 12,4.

B5_TOTGORnumber · opcionalSB5.B5_TOTGOR

Total de gordura por porção (g). Numérico 7,2.

B5_TOTGORSnumber · opcionalSB5.B5_TOTGORS

Total de gordura saturada por porção (g). Numérico 7,2.

B5_TOTGORTnumber · opcionalSB5.B5_TOTGORT

Total de gordura trans por porção (g). Numérico 7,2.

B5_CORstring · opcionalSB5.B5_COR

Cor do produto. Texto até 15 caracteres.

B5_ALTURAnumber · opcionalSB5.B5_ALTURA

Altura do produto (cm). Numérico 9,2.

B5_MODELOstring · opcionalSB5.B5_MODELO

Modelo do produto. Texto até 30 caracteres.

B5_MARCAstring · opcionalSB5.B5_MARCA

Marca comercial do produto. Texto até 60 caracteres.

recnointeger · opcional

Id técnico do registro (RecNo do AdvPL).

msuidstring · opcional

Identificador universal MS_UID (presente quando B5_MSUID existe no dicionário).

msuidtstring · opcional

Timestamp técnico associado ao msuid.

ComplementoPayload

object

Payload plano aceito em POST e PUT. Whitelist definida em CAMPOS_ALLOW no .prw. Em PUT sobre complemento bloqueado, o payload deve conter apenas B5_MSBLQL e/ou B5_MSBLQD — qualquer outro campo provoca 422. Campos ausentes no SX3 da empresa são silenciosamente ignorados pelo parser (GetSx3Cache vazio).

B5_CEMEstring · opcionalSB5.B5_CEME

Descrição técnica / complementar (Memo).

B5_CEMETINstring · opcionalSB5.B5_CEMETIN

Descrição em inglês (Memo).

B5_OBSERVstring · opcionalSB5.B5_OBSERV

Observações livres.

B5_CARACTstring · opcionalSB5.B5_CARACT

Características físico-químicas.

B5_FORMULstring · opcionalSB5.B5_FORMUL

Fórmula / receita.

B5_AUTOFABstring · opcionalSB5.B5_AUTOFAB

Indicador de auto-fabricação.

B5_USOPROstring · opcionalSB5.B5_USOPRO

Uso / aplicação.

B5_GARANTstring · opcionalSB5.B5_GARANT

Garantia (texto livre).

B5_MSBLQLstring · opcionalSB5.B5_MSBLQL

Flag de bloqueio TOTVS-padrão (SX3 pertence("12"), default "2"): "1"=Inativo, "2"=Ativo. MsExecAuto do MATA180 rejeita valores fora do domínio.

12

B5_MSBLQDstring · opcionalSB5.B5_MSBLQD

Bloqueio com vigência. Aceita string ISO YYYY-MM-DD ou vazia (limpa a data). Bloqueio fica ativo enquanto dDataBase > B5_MSBLQD.

B5_PESOnumber · opcionalSB5.B5_PESO

Peso do produto (kg). Numérico 12,4. Number JSON nativo.

B5_TOTGORnumber · opcionalSB5.B5_TOTGOR

Total de gordura por porção (g). Numérico 7,2.

B5_TOTGORSnumber · opcionalSB5.B5_TOTGORS

Total de gordura saturada por porção (g). Numérico 7,2.

B5_TOTGORTnumber · opcionalSB5.B5_TOTGORT

Total de gordura trans por porção (g). Numérico 7,2.

B5_CORstring · opcionalSB5.B5_COR

Cor do produto. Texto até 15 caracteres.

B5_ALTURAnumber · opcionalSB5.B5_ALTURA

Altura do produto (cm). Numérico 9,2.

B5_MODELOstring · opcionalSB5.B5_MODELO

Modelo do produto. Texto até 30 caracteres.

B5_MARCAstring · opcionalSB5.B5_MARCA

Marca comercial do produto. Texto até 60 caracteres.

ComplementoRef

object

Identificação enxuta retornada no data do CrudResponse (POST/PUT). Combina filial + código + ids técnicos sem repetir o payload inteiro.

filialstring · opcional

xFilial("SB5") trimado.

codstring · opcional

Código do produto / complemento.

recnointeger · opcional

RecNo do registro recém-gravado.

msuidstring · opcional

Identificador universal MS_UID (quando disponível).

msuidtstring · opcional

Timestamp técnico do MS_UID.

CrudResponse

object · envelope

Envelope padrão das respostas de POST / PUT / DELETE. data traz um ComplementoRef em POST/PUT (chave + ids técnicos do registro afetado), ou string vazia em DELETE.

successboolean · const: true

Sempre true em respostas de sucesso.

messagestring · obrigatório

Mensagem editorial de sucesso (ex: "Complemento incluido com sucesso.").

dataComplementoRef | string · opcional

Em POST/PUT, objeto ComplementoRef com filial + cod + ids técnicos. Em DELETE pode ser string vazia.

Erro

object · envelope

Envelope padrão de erros 4xx/5xx. data pode conter o token interno da causa (ex: mensagem do NomeAutoLog do MsExecAuto de MATA180) para tratamento programático, quando aplicável.

successboolean · const: false

Sempre false em erros.

messagestring · obrigatório

Mensagem editorial do erro (apresentável ao usuário final).

datastring · opcional

Token interno / detalhe técnico (ex: log do MsExecAuto).

Cenarios

Combinacoes documentadas (1 por example do openapi.yaml)

consulta-direta

GET /WsComplementoProduto/{cod}

Consulta direta por B5_COD (igual ao B1_COD). Retorna whitelist completo de CAMPOS_GET.

consulta-com-fields

GET /WsComplementoProduto/{cod}?fields=...

Reduz payload de retorno via fields=; util em mobile.

payload-minimo

POST /WsComplementoProduto/{cod}

Inclusao com campos descritivos basicos (B5_CEME, B5_OBSERV, B5_USOPRO, B5_GARANT). Pre-condicao: produto existir em SB1. Tier happy-path-minimal.

payload-completo

POST /WsComplementoProduto/{cod}

Inclusao com todos os campos descritivos do SB5, incluindo descricao em ingles (B5_CEMETIN) e indicadores de auto-fabricacao (B5_AUTOFAB) / formula (B5_FORMUL). Tier happy-path-realistic.

alterar-descricao

PUT /WsComplementoProduto/{cod}

Atualiza descricao tecnica e garantia sem mexer no bloqueio. Caminho comum.

liberar-bloqueio

PUT /WsComplementoProduto/{cod}

Caminho de desbloqueio: em registro bloqueado, paylod so com B5_MSBLQL="2" e/ou B5_MSBLQD="" e aceito (qualquer outro campo dispara 422).

bloquear-com-data

PUT /WsComplementoProduto/{cod}

Bloqueio manual com vigencia: B5_MSBLQL="1" + B5_MSBLQD ISO futura.

limpar-data

PUT /WsComplementoProduto/{cod}

Passa B5_MSBLQD="" para zerar a vigencia. Combinavel com mudanca de B5_MSBLQL.

delete-direto

DELETE /WsComplementoProduto/{cod}

Exclusao via MATA180 op=5. Falha 422 em complemento bloqueado.

byid-recno

GET /WsComplementoProduto/_byid?tipo=recno&valor=...

Lookup por recno da SB5 — caminho recomendado.

byid-msuid

GET /WsComplementoProduto/_byid?tipo=msuid&valor=...

Lookup por identificador universal — retorna 501 se SB5 nao tiver B5_MSUID no SX3. Ver Pendencias.

listagem-paginada

GET /WsComplementoProduto/_list?page=...&pageSize=...

Paginacao classica com page/pageSize em orderBy=chave. Default 50, max 500.

delta-sync

GET /WsComplementoProduto/_list?orderBy=recno&cursor=...

Sincronizacao incremental por recno; cliente itera via nextCursor.

Pendências conhecidas (rev5)

Campos físico/nutricional dependentes do SX3 da empresa (rev5). Os campos B5_PESO, B5_TOTGOR, B5_TOTGORS, B5_TOTGORT, B5_COR, B5_ALTURA, B5_MODELO e B5_MARCA precisam estar criados no dicionário da empresa-alvo para que o round-trip seja persistido. Ambientes sem esses campos: o parser ignora silenciosamente no payload (GetSx3Cache vazio) e o GET filtra via FieldPos > 0 — não há erro, mas o dado não trafega. Cadastro no SX3 é feito externamente (Configurador TOTVS), fora do escopo deste endpoint.

B5_MSBLQD nao serializado no GET. O whitelist CAMPOS_GET exclui B5_MSBLQD ate que U_RestMontaRegistro tenha serializador Date-aware. Tarefa transversal, fora do escopo do endpoint.

GET _byid?tipo=msuid condicional ao SX3. Quando o ambiente nao expoe B5_MSUID no SX3, a chamada retorna 501. Workaround: usar tipo=recno.

Sem _search dedicado. O complemento e identificado pelo proprio codigo do produto; typeahead por descricao deve usar CadastroProduto.

Campos opcionais variam por empresa. B5_CEMETIN, B5_AUTOFAB, B5_USOPRO etc nem sempre existem no SX3 — o endpoint filtra silenciosamente via FieldPos > 0. Se um campo no payload nao existe na empresa, ele e ignorado.

Sem validacao de produto bloqueado em SB1. O endpoint valida apenas existencia (DbSeek); produto em SB1 com B1_MSBLQL="1" nao impede inclusao/alteracao de complemento.