Tracking Pedido

Consulta Tracking pedido

get

/venda/v1/pedido/{codigo_pedido}/tracking

API para integração de tracking de pedidos. 1- Para consultar o tracking é obrigatório informar o número do pedido na chamada da API, exemplo da URL para consulta do pedido 6 https://{customerid}.systextilapps.com.br/venda/v1/pedido/6/tracking 2- 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

codigo_pedidonumber · máx: 6Opcional

Código do pedido de venda

Example: 1

codigo_statusstring · máx: 1Opcional

Código do status da posição do pedido de venda

1 - PEDIDO RECEBIDO - PEDIDO RECEBIDO, 2 - PEDIDO EM ANALISE FINANCEIRO - PEDIDO EM ANALISE FINANCEIRO, 3 - PEDIDO APROVADO FINANCEIRO - PEDIDO APROVADO FINANCEIRO, 4 - EM PROCESSO DE EMPENHO - PEDIDO EM SEPARACAO, 5 - GERACAO DE ROMANEIO PARA SEPARACAO - PEDIDO EM SEPARACAO, 6 - LIBERADO PARA SEPARACAO - PEDIDO EM SEPARACAO, 7 - EM PROCESSO DE SEPARACAO - PEDIDO EM SEPARACAO, 8 - EM PROCESSO DE FATURAMENTO - PEDIDO EM FATURAMENTO, 9 - PEDIDO FATURADO - PEDIDO FATURADO, 10 - SAIU PARA ENTREGA - PEDIDO SAIU PARA ENTREGA

Example: 2

status_descricaostring · máx: 100Opcional

Descrição do status da posição do pedido de venda

Example: PEDIDO RECEBIDO

data_ocorrenciastring · date-timeOpcional

Data da ocorrencia da mudança de status do pedido de venda

Example: 2023-11-12T13:23:36ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

trackingstring · máx: 100Opcional

Descrição agrupada do status da posição do pedido de venda

Example: PEDIDO CANCELADO

nota_fiscalstring · máx: 40Opcional

Número e série da nota fiscal.

Example: 342

data_atualizacao_apistring · date-timeOpcional

Data de atualização da API.

Example: 2024-02-10T03:00:00ZPattern: ^\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

/venda/v1/pedido/{codigo_pedido}/tracking

GET /venda/v1/pedido/{codigo_pedido}/tracking HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "codigo_pedido": 1,
  "codigo_status": 2,
  "status_descricao": "PEDIDO RECEBIDO",
  "data_ocorrencia": "2023-11-12T13:23:36Z",
  "tracking": "PEDIDO CANCELADO",
  "nota_fiscal": 342,
  "data_atualizacao_api": "2024-02-10T03:00:00Z"
}

AnteriorCarteira de Pedidos por Representante PróximoAlocar Sugestão

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Tracking pedido

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 Tracking pedido