Pesquisar Separações API 2.0
Serviço destinado a consulta de separações.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| situacao | int | opcional | Situação da separação: (1) Aguardando separação, (2) Separada, (3) Embalada ou (4) Em separação |
| formaEnvio | string | opcional | Forma de envio, conforme Tabela de forma de envio |
| dataInicial | string | opcional | Data incial dos pedidos que deseja consultar no formato dd/mm/yyyy |
| dataFinal | string | opcional | Data final dos pedidos que deseja consultar no formato dd/mm/yyyy |
| pagina (1) | int | opcional | Número da página |
(1) - Numero da página que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.
Retorno do serviço
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela "Status de Processamento" |
| retorno.status | string | - | obrigatório | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.codigo_erro (1) | int | - | condicional | Conforme tabela "Códigos de erro" |
| retorno.erros[ ] (1) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.erros[ ].campo | string | - | condicional | Nome do campo do body com problema(s) de validação |
| retorno.pagina | int | - | obrigatório | Número da página que está sendo retornada |
| retorno.numero_paginas | int | - | obrigatório | Número de paginas do retorno |
| retorno.separacoes (2) | list | - | condicional | Lista de resultados da pesquisa. |
| retorno.separacoes[ ].id | int | - | obrigatório | Número de identificação da separação no Tiny |
| retorno.separacoes[ ].idOrigem | int | - | obrigatório | Número de identificação da origem da separação no Tiny |
| retorno.separacoes[ ].objOrigem | string | - | obrigatório | Tipo da origem da separação |
| retorno.separacoes[ ].situacao | int | 1 | obrigatório | Situação da separação: (1) Aguardando separação, (2) Separada, (3) Embalada ou (4) Em separação |
| retorno.separacoes[ ].dataCriacao | string | 12 | obrigatório | Data de envio para separação no formato dd/mm/YYYY |
| retorno.separacoes[ ].dataSeparacao | string | 12 | opcional | Data de separação no formato dd/mm/YYYY |
| retorno.separacoes[ ].dataCheckout | string | 12 | opcional | Data de checkout no formato dd/mm/YYYY |
| retorno.separacoes[ ].destinatario | string | 60 | opcional | Nome do cliente atrelado ao endereço de entrega |
| retorno.separacoes[ ].idContato | int | - | obrigatório | Identificador do cliente atrelado a origem no Tiny |
| retorno.separacoes[ ].numero | int | - | obrigatório | Número da origem da separação |
| retorno.separacoes[ ].dataEmissao | string | 12 | obrigatório | Data de emissão atrelada a origem da separação |
| retorno.separacoes[ ].idFormaEnvio | int | - | opcional | Identificador da forma de envio no Tiny |
| retorno.separacoes[ ].numeroPedidoEcommerce | string | - | opcional | Identificador do pedido na integração |
| retorno.separacoes[ ].idOrigemVinc | int | - | opcional | Identificador do objeto vinculado a origem da separação |
| retorno.separacoes[ ].objOrigemVinc | string | - | opcional | Tipo do objeto vinculado a origem da separação |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
Exemplos de retorno da API
