Deposito

Consulta Depósito

get

/estoque/v1/deposito

API para integração de consulta de depósito 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

deposito_idnumber · máx: 3Opcional

Codigo Do Deposito

Example: 0

deposito_descricaostring · máx: 30Opcional

Descrição Do Deposito

Example: SYSTEMA - NAO EXCLUIR

deposito_empresanumber · máx: 3Opcional

Deposito Pertence A Esta Empresa

Example: 1

pronta_entregastring · máx: 5Opcional

Informe: "false"- Programa ou "true"- Pronta Entrega

Example: false

considera_necessidade_producaostring · máx: 5Opcional

Identifique se o material constante no depósito deve ser "true" - considerado ou "false" - não como disponível para cálculo de necessidade de produção

Example: true

tipo_volumenumber · máx: 1Opcional

Informe: 0-Sem Volune 1-Tag 2-Rolo Acabado 4-Rolo Cru 7-Fio 9-Lote Algodao

Example: 0

confirma_coletastring · máx: 5Opcional

Informe: "true"-Exige Confirmacao Coleta "false"-Nao Exige Conformacao De Coleta

Example: false

rolo_ministring · máx: 5Opcional

Informe: "true" - Só permite vender um nini rolo de cada produto, por pedido ou "false" - Podem ser vendidos quantos mini rolos forem desejados do mesmo produto.

Example: true

tipo_produto_depositonumber · máx: 1Opcional

Informe: 1 - Primeira Qualidade 2-Segunda Qualidade 3-Retalho 4-Amostra

Example: 1

deposito_origemnumber · máx: 3Opcional

Informe Deposito Origem

Example: 0

consiste_solicitacao_manutencaostring · máx: 5Opcional

Informe: true ou false

Example: 0

deposito_destinonumber · máx: 3Opcional

Informe Deposito Destino

Example: 501

deposito_terceironumber · máx: 1Opcional

Informe Deposito De Terceiro

Example: 2

aceita_requisicao_almoxarifadostring · máx: 5Opcional

Informe true ou false

Example: false

controla_ficha_cardexstring · máx: 5Opcional

Informe true ou false

Example: false

disponivel_internetstring · máx: 5Opcional

Informe true ou false

Example: false

deposito_inativostring · máx: 5Opcional

Informe true ou false

Example: true

data_limite_inativostring · date-timeOpcional

Data Que Foi Inativado Deposito

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

tipo_propriedade_depositonumber · máx: 1Opcional

Informe: 1-Estoque Proprio 2-Esoque Proprio Em Poder De Terceiros 3-Estoque De Terceiros

Example: 1

tipo_valorizacaonumber · máx: 1Opcional

Informe: 1-Materia Prima 2-Produto Em Elaboracao 3-Produto Semi Acabado 4-Produto Fabricado

Example: 1

processo_produtivo_idnumber · máx: 2Opcional

Informe Do Codigo Do Processo produtivo

Example: 0

processo_produtivo_descricaostring · máx: 40Opcional

Descrição do processo produtivo

empenha_almoxarifadostring · máx: 5Opcional

Informe true ou false

Example: true

observacao_deposito_idnumber · máx: 3Opcional

Informe O Codigo De Observação

Example: 0

observacao_deposito_descricaostring · máx: 20Opcional

Descrição da Observação

deposito_lojastring · máx: 5Opcional

Informe: "false"- Deposito Não Será Usado Por Loja "true"- Deposito Será Usuado Por Loja

Example: true

centro_custo_equalizacaonumber · máx: 6Opcional

Informe O Centro De Custo De Equalizacao no caso de unificação de custo em mais de um depósito

Example: 0

cnpj_9_terceironumber · máx: 9Opcional

Informe Cnpj9 De Terceiro

Example: 0

cnpj_4_terceironumber · máx: 4Opcional

Informe Cnpj4 De Terceiro

Example: 0

cnpj_2_terceironumber · máx: 2Opcional

Informe Cnpj2 De Terceiro

Example: 0

calcula_disponibilidadestring · máx: 5Opcional

Informe: true ou false

Example: true

sugere_pedidostring · máx: 5Opcional

Informe: true ou false

Example: true

limpa_pedido_volumestring · máx: 5Opcional

Informe: true ou false

Example: true

data_atualizacao_apistring · date-timeOpcional

Data atualização da API

Example: 2024-01-29T22:18:48ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

401

Não autorizado.

application/json

500

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

application/json

get

/estoque/v1/deposito

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

{
  "deposito_id": 0,
  "deposito_descricao": "SYSTEMA - NAO EXCLUIR",
  "deposito_empresa": 1,
  "pronta_entrega": "false",
  "considera_necessidade_producao": "true",
  "tipo_volume": 0,
  "confirma_coleta": "false",
  "rolo_mini": "true",
  "tipo_produto_deposito": 1,
  "deposito_origem": 0,
  "consiste_solicitacao_manutencao": 0,
  "deposito_destino": 501,
  "deposito_terceiro": 2,
  "aceita_requisicao_almoxarifado": "false",
  "controla_ficha_cardex": "false",
  "disponivel_internet": "false",
  "deposito_inativo": "true",
  "data_limite_inativo": null,
  "tipo_propriedade_deposito": 1,
  "tipo_valorizacao": 1,
  "processo_produtivo_id": 0,
  "processo_produtivo_descricao": null,
  "empenha_almoxarifado": "true",
  "observacao_deposito_id": 0,
  "observacao_deposito_descricao": null,
  "deposito_loja": "true",
  "centro_custo_equalizacao": 0,
  "cnpj_9_terceiro": 0,
  "cnpj_4_terceiro": 0,
  "cnpj_2_terceiro": 0,
  "calcula_disponibilidade": "true",
  "sugere_pedido": "true",
  "limpa_pedido_volume": "true",
  "data_atualizacao_api": "2024-01-29T22:18:48Z"
}

AnteriorRequisição Estoque PróximoPlanejamento Industrial

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Depósito

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

Consulta Depósito