Produto

Consulta Produto

get

/material/v1/produto

API para integração de consulta de Produto. 1- Devido a limitação do Swagger na quantidade de caracters que podem ser retornadas, foram criados os campos abaixo para limitar a quantidade de registros quando necessário. O erro retornado quando o limite de caracteres é ultrapassado é "413 - request entity too large".

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

limitinteger · int32 · mín: 1 · máx: 100Opcional

Quantidade máxima de items retornados.

Default: 20

offsetinteger · int32Opcional

Quantidade de items para ignorar antes de retornar resultado.

Default: 0

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

A filtragem é o processo de limitar um recurso de coleção usando uma definição de filtro dinâmico por solicitação em vários recursos de página, em que cada página contém um subconjunto de itens encontrados na coleção completa. A filtragem permite a passagem eficiente de grandes coleções.

Para filtrar em uma consulta, inclua o parâmetro q=FilterObject, onde FilterObject é um objeto JSON que representa a seleção e classificação customizadas a serem aplicadas ao recurso. Por exemplo, suponha o seguinte recurso:

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

(All first columns and or high order operators -- $and and $ors -- defined at the first level of the JSON will be joined and an implicit AND) (Example: Salary greater than 1000 and name starts with S or T)

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

nivel_produtostring · máx: 1Obrigatório

(1) - Peca, (2) - Tecido, (4) - Tecido Cru, (5) - Serviços, (7) - Fio, (8) - Largura Tecido ou (9) - Material Comprado

Example: 7

grupo_idstring · máx: 5Obrigatório

Informe O Grupo Do Produto

Example: 77001

grupo_descricaostring · máx: 30Opcional

Descrição do grupo

Example: Teste

subgrupo_idstring · máx: 3Obrigatório

Informe O Subgrupo Do Produto

Example: 1

subgrupo_descricaostring · máx: 11Opcional

Descrição do subgrupo

Example: Teste

item_estrutura_idstring · máx: 6Obrigatório

Informa O Item Do Produto

Example: CRU001

item_estrutura_descricaostring · máx: 20Opcional

Descrição do item

Example: CRU

descricao_produtostring · máx: 65Opcional

Descrição do produto

Example: Teste

descricao_produto_complementarstring · máx: 140Opcional

Descrição do produto complementar

Example: Teste

descricao_produto_inglesstring · máx: 65Opcional

Descrição do produto em inglês

Example: Teste

descricao_produto_espanholstring · máx: 60Opcional

Descrição do produto em espanhol

Example: Teste

situacao_produtonumber · máx: 1Opcional

Situação do produto (0) - Ativo, (1) - Inativo ou (2) - Lançamento

Example: 0

classificacao_fiscalstring · máx: 15Opcional

Classificação fiscal do produto

Example: 52052310

unidade_medida_idstring · máx: 2Opcional

Unidade de medida do produto

Example: KG

unidade_medida_descricaostring · máx: 20Opcional

Descrição da unidade de medida

Example: QUILOGRAMA

linha_produto_idnumber · máx: 2Opcional

Linha do produto

Example: 33

linha_produto_descricaostring · máx: 40Opcional

Descrição da linha do produto

Example: ENTRELAÇADO

colecao_idnumber · máx: 3Opcional

Coleção do produto

Example: 3

colecao_descricaostring · máx: 20Opcional

Descrição da coleção do produto

Example: MONARO 2019/01

artigo_idnumber · máx: 4Opcional

Artigo do produto

Example: 5

artigo_descricaostring · máx: 25Opcional

Descrição Artigo do produto

Example: FIO

artigo_cotas_idnumber · máx: 4Opcional

Artigo de cotas do produto

Example: 3

artigo_cotas_descricaostring · máx: 25Opcional

Descrição do artigo de cotas do produto

Example: FIO

conta_estoque_idnumber · máx: 2Opcional

Conta de estoque

Example: 8

conta_estoque_descricaostring · máx: 40Opcional

Descrição Conta de estoque

Example: FITAS PARA LACO

comprado_fabricadonumber · máx: 1Opcional

'Se nivel_estrutura in (3,5) [1 - serviço sim ou 2 - Não é serviço] Indicador de comprado ou fabricado (1) - Comprado, (2) - Fabricado'

Example: 2

variacao_coresnumber · máx: 2Opcional

Quantidade de variação de cores apenas para nivel_estrutura = 3

Example: 0

codigo_contabil_idnumber · máx: 6Opcional

Código contábil

Example: 1456

codigo_contabil_descricaostring · máx: 45Opcional

Descrição do Código contábil

Example: PRODUTOS ACABADOS - FIO

tipo_produtonumber · máx: 1Opcional

'Se nivel_estrutura in (2,4) [1 - Tecido Normal (liso e estampado), 2 - Tecido Listrado (com fio tinto), 3 - Gola, 4 - Punho, 5 - Ribanas, 6 - Retilínea(Golas, punhos, tiras, decotes)] Se nivel_estrutura = 3 [1 - Estampa aberta - estampa aplicada na peça antes de ser costurada, 2 - Estampa fechada - estampa aplicada na peça depois de ser costurada, 3 - Estampa corrida - estampa aplicada no tecido quando está ainda em rolo, 4 - Bordado, 5 - Silk, 6 - Embalagem, 7 - Lavado]'

Example: 1

tecido_modularstring · máx: 5Opcional

Identifique se o tecido é modular. Informe: True ou False

Example: false

ceststring · máx: 10Opcional

Código do Cest do produto

tipo_codigo_eannumber · máx: 1Opcional

(1) - por cor ou (2) - por tamanho

Example: 1

cor_de_estoquestring · máx: 6Opcional

'Quando o tipo código EAN for: 1 - por cor - não é obrigatório informar um valor para COR/SORTIMENTO ESTOQUE, pode-se informar uma cor para controlar o estoque ou informar '000000' (zeros) para nenhuma cor. 2 - por tamanho - é obrigatório informar a COR/SORTIMENTO ESTOQUE.'

Example: 0

produto_prototipostring · máx: 5Opcional

Informe: True ou False

Example: false

grade_tamanho_idnumber · máx: 2Opcional

Código da grade de tamanho

Example: 0

grade_tamanho_descricaostring · máx: 10Opcional

Descrição da grade de tamanho

Example: UNICO

faixa_etaria_produto_idnumber · máx: 3Opcional

Código da faixa etária

Example: 0

faixa_etaria_produto_descricaostring · máx: 60Opcional

Descrição da faixa etária

Example: Teste

faixa_etaria_produto_custo_idnumber · máx: 3Opcional

Código da faixa etária custo

Example: 0

faixa_etaria_produto_custo_desstring · máx: 60Opcional

Descrição da faixa etária custo

tipo_gaiolastring · máx: 2Opcional

Tipo de processo/gaiola: (0) - Nenhum, (1) - Aéreo, (2) - Normal ou (3) - Outros

Example: 0

pasta_banhonumber · máx: 1Opcional

Informação de pasta banho apenas para serviço

Example: 0

fator_absorcaonumber · máx: 9Opcional

Fator de absorção de receita

Example: 0

descricao_complementarstring · máx: 30Opcional

Descrição complementar

codigo_barrasstring · máx: 16Opcional

Código de barras do produto

origem_produtonumber · máx: 1Opcional

Origem do produto: (1) para NACIONAL, (2) para IMPORTADO e (3) para SEM CLASSIFICAÇÃO

Example: 1

complemento_produtostring · máx: 60Opcional

Descrição do complemento do produto

Example: Teste

variante_integracaostring · máx: 10Opcional

Informação é carregada pela integração com o Centric PLM

observacao_cor_tagstring · máx: 100Opcional

Informação é carregada pela integração com o Centric PLM

observacao_ficha_tecnica_estampastring · máx: 100Opcional

Observação para ficha tecnica de etampa

numero_graficonumber · máx: 6OpcionalExample: 0

tipo_materia_primanumber · máx: 1Opcional

'0 - Não é matéria prima de tingimento 1 - CORANTES - Calcula consumo com base no peso do produto a produzir 2 - AUXILIAR DE TINGIMENTO - Calcula consumo com base no volume de banho do tingimento'

Example: 0

tipo_produto_quimico_idnumber · máx: 3Opcional

Tipo de produto quimico

Example: 0

tipo_produto_quimico_descricaostring · máx: 30Opcional

Descrição do tipo de produto quimico

Example: Teste

motivo_uso_idnumber · máx: 3Opcional

Motivo do uso da Matéria prima

Example: 0

motivo_uso_descricaostring · máx: 60Opcional

Descrição do motivo do uso da Matéria prima

Example: CONTROLE DO SISTEMA

percentual_concentracaonumber · máx: 5Opcional

Percentual de concentração

Example: 0

tipo_dosagem_orgatexnumber · máx: 1Opcional

Tipo de dosagem para orgatex: 2 - Automática e 5 - Manual

Example: 5

quantidade_minima_envionumber · máx: 9Opcional

Quantidade minima para envio automatico através de integração

servico_idstring · máx: 5Opcional

Código do serviço para o Sped

Example: 0

servico_descricaostring · máx: 300Opcional

Descrição do serviço para o Sped

descricao_marca_registradastring · máx: 50Opcional

Descrição da marca para cartela

data_cadastrostring · date-timeOpcional

Data de cadastro do produto

Example: 2007-01-15T02:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

tipo_produto_global_idnumber · máx: 2Opcional

Código do tipo de produto global

Example: 6

tipo_produto_global_descricaostring · máx: 60Opcional

Descrição do tipo de produto global

Example: FIO CRU

peso_oznumber · máx: 9Opcional

Peso em OZ

Example: 606.95

ligamentostring · máx: 60Opcional

Desenho do urdume definindo os passamentos dos fios que dara forma ao tecido

metragemnumber · máx: 9Opcional

Quantidade padrão de metros por rolo

Example: 0

composicao_1_idstring · máx: 6Opcional

Simbolo da composição 1 do produto

composicao_1_descricaostring · máx: 15Opcional

Descrição da composição 1 do produto

composicao_1_percentualnumber · máx: 6Opcional

Percentual da composição 1 do produto

Example: 0

composicao_2_idstring · máx: 6Opcional

Simbolo da composição 2 do produto

composicao_2_descricaostring · máx: 15Opcional

Descrição da composição 2 do produto

composicao_2_percentualnumber · máx: 6Opcional

Percentual da composição 2 do produto

Example: 0

composicao_3_idstring · máx: 6Opcional

Simbolo da composição 3 do produto

composicao_3_descricaostring · máx: 15Opcional

Descrição da composição 3 do produto

composicao_3_percentualnumber · máx: 6Opcional

Percentual da composição 3 do produto

Example: 0

composicao_4_idstring · máx: 6Opcional

Simbolo da composição 4 do produto

composicao_4_descricaostring · máx: 15Opcional

Descrição da composição 4 do produto

composicao_4_percentualnumber · máx: 6Opcional

Percentual da composição 4 do produto

Example: 0

composicao_5_idstring · máx: 6Opcional

Simbolo da composição 5 do produto

composicao_5_descricaostring · máx: 15Opcional

Descrição da composição 5 do produto

composicao_5_percentualnumber · máx: 6Opcional

Percentual da composição 5 do produto

Example: 0

observacao_produtostring · máx: 255Opcional

Observação do produto

cnpj_9number · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0

cnpj_4number · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0

cnpj_2number · máx: 2Opcional

Os 2 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0

nome_clientestring · máx: 40Opcional

Nome/Razão Social

larguranumber · máx: 7Opcional

Largura do tecido

Example: 0

percentual_encolhimentonumber · máx: 6Opcional

Percentual de Encolhimento

Example: 0

data_atualizacao_apistring · date-timeOpcional

Data de atualização da API.

Example: 2024-02-08T18:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

natur_operacaonumber · máx: 3Opcional

Natureza de Operação

Example: 0

familia_atributostring · máx: 6Opcional

Família Atributo

401

Não autorizado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

get

/material/v1/produto

GET /material/v1/produto HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "nivel_produto": 7,
  "grupo_id": 77001,
  "grupo_descricao": "Teste",
  "subgrupo_id": 1,
  "subgrupo_descricao": "Teste",
  "item_estrutura_id": "CRU001",
  "item_estrutura_descricao": "CRU",
  "descricao_produto": "Teste",
  "descricao_produto_complementar": "Teste",
  "descricao_produto_ingles": "Teste",
  "descricao_produto_espanhol": "Teste",
  "situacao_produto": 0,
  "classificacao_fiscal": 52052310,
  "unidade_medida_id": "KG",
  "unidade_medida_descricao": "QUILOGRAMA",
  "linha_produto_id": 33,
  "linha_produto_descricao": "ENTRELAÇADO",
  "colecao_id": 3,
  "colecao_descricao": "MONARO 2019/01",
  "artigo_id": 5,
  "artigo_descricao": "FIO",
  "artigo_cotas_id": 3,
  "artigo_cotas_descricao": "FIO",
  "conta_estoque_id": 8,
  "conta_estoque_descricao": "FITAS PARA LACO",
  "comprado_fabricado": 2,
  "variacao_cores": 0,
  "codigo_contabil_id": 1456,
  "codigo_contabil_descricao": "PRODUTOS ACABADOS - FIO",
  "tipo_produto": 1,
  "tecido_modular": "false",
  "cest": null,
  "tipo_codigo_ean": 1,
  "cor_de_estoque": 0,
  "produto_prototipo": "false",
  "grade_tamanho_id": 0,
  "grade_tamanho_descricao": "UNICO",
  "faixa_etaria_produto_id": 0,
  "faixa_etaria_produto_descricao": "Teste",
  "faixa_etaria_produto_custo_id": 0,
  "faixa_etaria_produto_custo_des": null,
  "tipo_gaiola": 0,
  "pasta_banho": 0,
  "fator_absorcao": 0,
  "descricao_complementar": null,
  "codigo_barras": null,
  "origem_produto": 1,
  "complemento_produto": "Teste",
  "variante_integracao": null,
  "observacao_cor_tag": null,
  "observacao_ficha_tecnica_estampa": null,
  "numero_grafico": 0,
  "tipo_materia_prima": 0,
  "tipo_produto_quimico_id": 0,
  "tipo_produto_quimico_descricao": "Teste",
  "motivo_uso_id": 0,
  "motivo_uso_descricao": "CONTROLE DO SISTEMA",
  "percentual_concentracao": 0,
  "tipo_dosagem_orgatex": 5,
  "quantidade_minima_envio": null,
  "servico_id": 0,
  "servico_descricao": null,
  "descricao_marca_registrada": null,
  "data_cadastro": "2007-01-15T02:00:00Z",
  "tipo_produto_global_id": 6,
  "tipo_produto_global_descricao": "FIO CRU",
  "peso_oz": 606.95,
  "ligamento": null,
  "metragem": 0,
  "composicao_1_id": "",
  "composicao_1_descricao": null,
  "composicao_1_percentual": 0,
  "composicao_2_id": null,
  "composicao_2_descricao": null,
  "composicao_2_percentual": 0,
  "composicao_3_id": null,
  "composicao_3_descricao": null,
  "composicao_3_percentual": 0,
  "composicao_4_id": null,
  "composicao_4_descricao": null,
  "composicao_4_percentual": 0,
  "composicao_5_id": null,
  "composicao_5_descricao": null,
  "composicao_5_percentual": 0,
  "observacao_produto": null,
  "cnpj_9": 0,
  "cnpj_4": 0,
  "cnpj_2": 0,
  "nome_cliente": null,
  "largura": 0,
  "percentual_encolhimento": 0,
  "data_atualizacao_api": "2024-02-08T18:00:00Z",
  "natur_operacao": 0,
  "familia_atributo": null,
  "acompanhamentos": [],
  "infos_diversas_grupo": [],
  "infos_diversas_item": [],
  "colecoes_item": [],
  "natureza_rendimento": []
}

Cadastro Produto

post

/material/v1/produto

API para integração de POST de Produto.

(*) - Campos obrigatórios/campos chave: nivel_produto, grupo_id, subgrupo_id, item_estrutura_id, codigo_acompanhamento, item_estrutura_id

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

201

Sucesso na inclusão.

application/json

400

Erro em validação de negócio.

application/json

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

409

Requisição não aceita, envio já cadastrado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

post

/material/v1/produto

POST /material/v1/produto HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2607

{
  "items": [
    {
      "nivel_produto": 7,
      "grupo_id": 77001,
      "grupo_descricao": "Teste",
      "subgrupo_id": 1,
      "subgrupo_descricao": "Teste",
      "item_estrutura_id": "CRU001",
      "item_estrutura_descricao": "CRU",
      "descricao_produto": "Teste",
      "descricao_produto_complementar": "Teste",
      "descricao_produto_ingles": "Teste",
      "descricao_produto_espanhol": "Teste",
      "situacao_produto": 0,
      "classificacao_fiscal": 52052310,
      "unidade_medida_id": "KG",
      "unidade_medida_descricao": "QUILOGRAMA",
      "linha_produto_id": 33,
      "linha_produto_descricao": "ENTRELAÇADO",
      "colecao_id": 3,
      "colecao_descricao": "MONARO 2019/01",
      "artigo_id": 5,
      "artigo_descricao": "FIO",
      "artigo_cotas_id": 3,
      "artigo_cotas_descricao": "FIO",
      "conta_estoque_id": 8,
      "conta_estoque_descricao": "FITAS PARA LACO",
      "comprado_fabricado": 2,
      "variacao_cores": 0,
      "codigo_contabil_id": 1456,
      "codigo_contabil_descricao": "PRODUTOS ACABADOS - FIO",
      "tipo_produto": 1,
      "tecido_modular": "false",
      "cest": null,
      "tipo_codigo_ean": 1,
      "cor_de_estoque": 0,
      "produto_prototipo": "false",
      "grade_tamanho_id": 0,
      "grade_tamanho_descricao": "UNICO",
      "faixa_etaria_produto_id": 0,
      "faixa_etaria_produto_descricao": "Teste",
      "faixa_etaria_produto_custo_id": 0,
      "faixa_etaria_produto_custo_des": null,
      "tipo_gaiola": 0,
      "pasta_banho": 0,
      "fator_absorcao": 0,
      "descricao_complementar": null,
      "codigo_barras": null,
      "origem_produto": 1,
      "complemento_produto": "Teste",
      "variante_integracao": null,
      "observacao_cor_tag": null,
      "observacao_ficha_tecnica_estampa": null,
      "numero_grafico": 0,
      "tipo_materia_prima": 0,
      "tipo_produto_quimico_id": 0,
      "tipo_produto_quimico_descricao": "Teste",
      "motivo_uso_id": 0,
      "motivo_uso_descricao": "CONTROLE DO SISTEMA",
      "percentual_concentracao": 0,
      "tipo_dosagem_orgatex": 5,
      "quantidade_minima_envio": null,
      "servico_id": 0,
      "servico_descricao": null,
      "descricao_marca_registrada": null,
      "data_cadastro": "2007-01-15T02:00:00Z",
      "tipo_produto_global_id": 6,
      "tipo_produto_global_descricao": "FIO CRU",
      "peso_oz": 606.95,
      "ligamento": null,
      "metragem": 0,
      "composicao_1_id": "",
      "composicao_1_descricao": null,
      "composicao_1_percentual": 0,
      "composicao_2_id": null,
      "composicao_2_descricao": null,
      "composicao_2_percentual": 0,
      "composicao_3_id": null,
      "composicao_3_descricao": null,
      "composicao_3_percentual": 0,
      "composicao_4_id": null,
      "composicao_4_descricao": null,
      "composicao_4_percentual": 0,
      "composicao_5_id": null,
      "composicao_5_descricao": null,
      "composicao_5_percentual": 0,
      "observacao_produto": null,
      "cnpj_9": 0,
      "cnpj_4": 0,
      "cnpj_2": 0,
      "nome_cliente": null,
      "largura": 0,
      "percentual_encolhimento": 0,
      "data_atualizacao_api": "2024-02-08T18:00:00Z",
      "natur_operacao": 0,
      "familia_atributo": null,
      "acompanhamentos": [],
      "infos_diversas_grupo": [],
      "infos_diversas_item": [],
      "colecoes_item": [],
      "natureza_rendimento": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Alteração Produto

put

/material/v1/produto

API para integração de PUT de Produto.

(*) - Campos obrigatórios/campos chave: nivel_produto, grupo_id, subgrupo_id, item_estrutura_id, codigo_acompanhamento, item_estrutura_id

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

put

/material/v1/produto

PUT /material/v1/produto HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2607

{
  "items": [
    {
      "nivel_produto": 7,
      "grupo_id": 77001,
      "grupo_descricao": "Teste",
      "subgrupo_id": 1,
      "subgrupo_descricao": "Teste",
      "item_estrutura_id": "CRU001",
      "item_estrutura_descricao": "CRU",
      "descricao_produto": "Teste",
      "descricao_produto_complementar": "Teste",
      "descricao_produto_ingles": "Teste",
      "descricao_produto_espanhol": "Teste",
      "situacao_produto": 0,
      "classificacao_fiscal": 52052310,
      "unidade_medida_id": "KG",
      "unidade_medida_descricao": "QUILOGRAMA",
      "linha_produto_id": 33,
      "linha_produto_descricao": "ENTRELAÇADO",
      "colecao_id": 3,
      "colecao_descricao": "MONARO 2019/01",
      "artigo_id": 5,
      "artigo_descricao": "FIO",
      "artigo_cotas_id": 3,
      "artigo_cotas_descricao": "FIO",
      "conta_estoque_id": 8,
      "conta_estoque_descricao": "FITAS PARA LACO",
      "comprado_fabricado": 2,
      "variacao_cores": 0,
      "codigo_contabil_id": 1456,
      "codigo_contabil_descricao": "PRODUTOS ACABADOS - FIO",
      "tipo_produto": 1,
      "tecido_modular": "false",
      "cest": null,
      "tipo_codigo_ean": 1,
      "cor_de_estoque": 0,
      "produto_prototipo": "false",
      "grade_tamanho_id": 0,
      "grade_tamanho_descricao": "UNICO",
      "faixa_etaria_produto_id": 0,
      "faixa_etaria_produto_descricao": "Teste",
      "faixa_etaria_produto_custo_id": 0,
      "faixa_etaria_produto_custo_des": null,
      "tipo_gaiola": 0,
      "pasta_banho": 0,
      "fator_absorcao": 0,
      "descricao_complementar": null,
      "codigo_barras": null,
      "origem_produto": 1,
      "complemento_produto": "Teste",
      "variante_integracao": null,
      "observacao_cor_tag": null,
      "observacao_ficha_tecnica_estampa": null,
      "numero_grafico": 0,
      "tipo_materia_prima": 0,
      "tipo_produto_quimico_id": 0,
      "tipo_produto_quimico_descricao": "Teste",
      "motivo_uso_id": 0,
      "motivo_uso_descricao": "CONTROLE DO SISTEMA",
      "percentual_concentracao": 0,
      "tipo_dosagem_orgatex": 5,
      "quantidade_minima_envio": null,
      "servico_id": 0,
      "servico_descricao": null,
      "descricao_marca_registrada": null,
      "data_cadastro": "2007-01-15T02:00:00Z",
      "tipo_produto_global_id": 6,
      "tipo_produto_global_descricao": "FIO CRU",
      "peso_oz": 606.95,
      "ligamento": null,
      "metragem": 0,
      "composicao_1_id": "",
      "composicao_1_descricao": null,
      "composicao_1_percentual": 0,
      "composicao_2_id": null,
      "composicao_2_descricao": null,
      "composicao_2_percentual": 0,
      "composicao_3_id": null,
      "composicao_3_descricao": null,
      "composicao_3_percentual": 0,
      "composicao_4_id": null,
      "composicao_4_descricao": null,
      "composicao_4_percentual": 0,
      "composicao_5_id": null,
      "composicao_5_descricao": null,
      "composicao_5_percentual": 0,
      "observacao_produto": null,
      "cnpj_9": 0,
      "cnpj_4": 0,
      "cnpj_2": 0,
      "nome_cliente": null,
      "largura": 0,
      "percentual_encolhimento": 0,
      "data_atualizacao_api": "2024-02-08T18:00:00Z",
      "natur_operacao": 0,
      "familia_atributo": null,
      "acompanhamentos": [],
      "infos_diversas_grupo": [],
      "infos_diversas_item": [],
      "colecoes_item": [],
      "natureza_rendimento": []
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Exclusão Produto

delete

/material/v1/produto

API para integração de exclusão de Produto.

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

delete

/material/v1/produto

DELETE /material/v1/produto HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

AnteriorMovimento de Estoque PróximoProjeto

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Produto

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Column context override

hashtagCadastro Produto

hashtagAPI para integração de POST de Produto.

hashtagAlteração Produto

hashtagAPI para integração de PUT de Produto.

hashtagExclusão Produto

hashtagAPI para integração de exclusão de Produto.

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Consulta Produto

Cadastro Produto

API para integração de POST de Produto.

Alteração Produto

API para integração de PUT de Produto.

Exclusão Produto

API para integração de exclusão de Produto.