Obter Separação API 2.0
Serviço destinado a obter os dados de uma separação.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| idSeparacao | int | obrigatório | Número de identificação da separação no Tiny |
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.separacao (2) | object | - | condicional | Elemento utilizado para representar uma separação. |
| retorno.separacao.id | int | - | obrigatório | Número de identificação da separação no Tiny |
| retorno.separacao.idOrigem | int | - | obrigatório | Número de identificação da origem da separação no Tiny |
| retorno.separacao.objOrigem | string | - | obrigatório | Tipo da origem da separação |
| retorno.separacao.situacao | int | 1 | obrigatório | Situação da separação: (1) Aguardando separação, (2) Separada, (3) Embalada ou (4) Em separação |
| retorno.separacao.dataCriacao | string | 12 | obrigatório | Data de envio para separação no formato dd/mm/YYYY |
| retorno.separacao.dataSeparacao | string | 12 | opcional | Data de separação no formato dd/mm/YYYY |
| retorno.separacao.dataCheckout | string | 12 | opcional | Data de checkout no formato dd/mm/YYYY |
| retorno.separacao.idUsuarioEmbalador | int | - | opcional | Identificador do usuário embalador logado no Tiny |
| retorno.separacao.situacaoCheckout | int | 1 | obrigatório | Situação do checkout: (1) Disponível ou (2) Bloqueado |
| retorno.separacao.itens | list | - | opcional | Lista contendo os itens da separação |
| retorno.separacao.itens[ ].idProduto | int | - | obrigatório | Identificador do produto no Tiny |
| retorno.separacao.itens[ ].descricao | string | - | obrigatório | Descrição do produto |
| retorno.separacao.itens[ ].codigo | string | - | obrigatório | Código SKU do produto |
| retorno.separacao.itens[ ].quantidade | decimal | - | obrigatório | Quantidade do produto |
| retorno.separacao.itens[ ].unidade | string | - | obrigatório | Unidade do produto |
| retorno.separacao.itens[ ].localizacao | string | - | obrigatório | Localização do produto |
| retorno.separacao.itens[ ].infoAdicional | string | - | obrigatório | Informação adicional do produto |
| retorno.separacao.qtdVolumes | int | - | obrigatório | Quantidade de volumes da separação |
| retorno.separacao.numero | int | - | obrigatório | Número da origem da separação |
| retorno.separacao.idContato | int | - | obrigatório | Identificador do cliente atrelado a origem no Tiny |
| retorno.separacao.destinatario | string | 60 | opcional | Nome do cliente atrelado ao endereço de entrega |
| retorno.separacao.dataEmissao | string | 12 | obrigatório | Data de emissão atrelada a origem da separação |
| retorno.separacao.idFormaEnvio | int | - | opcional | Identificador da forma de envio no Tiny |
| retorno.separacao.formaEnvio | string | - | opcional | Descrição da forma de envio |
| retorno.separacao.formaFrete | string | - | opcional | Descrição da forma de frete |
| retorno.separacao.numeroPedidoEcommerce | string | - | opcional | Identificador do pedido na integração |
| retorno.separacao.situacaoOrigem (3) | int | 1 | condicional | Situacao da 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".
(3) - Valores serão condicionais a origem da separação.
Exemplos de retorno da API
