Versão 1.00
Estrutura de envio
| Nome | Nível | Obrigatório | Tipo de dado | Descrição |
|---|---|---|---|---|
| cancelar_pedido | 0 | Sim | Estrutural | |
| pedido | 1 | Sim | Estrutural | |
| id | 2 | Sim | Inteiro | Id do pedido a ser cancelado |
| id_motivo_cancelamento | 2 | Sim/Não - Depende de configurações no ERP | Inteiro | Id do motivo de cancelamento. |
Estrutura de retorno
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| retorno | 0 | Estrutural | |
| status | 1 | Inteiro | 0 - Indica que erros ocorreram em um dos registros 1 - Indica sucesso em todos os registros |
| registros | 1 | Estrutural | |
| id | 2 | Texto | Id do registro enviado (Informado pela aplicação cliente) |
| id_gerado | 2 | Inteiro | Id do registro gerado |
| status | 2 | Inteiro | 0 – Indica que algum erro impediu a atualização ou inserção do registro. 1 – Indica sucesso |
| mensagens | 2 | Estrutural | Agrupamento de mensagens que fazem referência a cada ocorrência no id_gerado/id |
| mensagem | 3 | Estrutural | |
| id | 4 | Inteiro | Id da mensagem de retorno |
| descricao | 4 | Texto | Conteúdo da mensagem de retorno |
| mensagens | 1 | Estrutural | Agrupamento de mensagens que fazem referência ao retorno em geral |
| mensagem | 2 | Estrutural | |
| id | 3 | Inteiro | Id da mensagem de retorno |
| descricao | 3 | Texto | Conteúdo da mensagem de retorno |
Exemplo de utilização
<cancelar_pedido versao="1.00" token="tkn-vinhasoft-001" id_empresa="1">
<pedido>
<id>167811</id>
<id_motivo_cancelamento>4</id_motivo_cancelamento>
</pedido>
</cancelar_pedido>
Exemplos de retorno
<retorno>
<registros>
<registro>
<id>167811</id>
<id_gerado>0</id_gerado>
<status>1</status>
<mensagens>
<mensagem>
<id>17</id>
<descricao>Registro atualizado com sucesso.</descricao>
</mensagem>
</mensagens>
</registro>
</registros>
<status>1</status>
</retorno>
<retorno>
<registros>
<registro>
<id>16781</id>
<id_gerado>0</id_gerado>
<status>0</status>
<mensagens>
<mensagem>
<id>13</id>
<descricao>Documento de venda não localizado ou inexistente.</descricao>
</mensagem>
</mensagens>
</registro>
</registros>
<status>0</status>
</retorno>
<retorno>
<registros>
<registro>
<id>1231</id>
<id_gerado>0</id_gerado>
<status>0</status>
<mensagens>
<mensagem>
<id>70</id>
<descricao>As configurações gerais do sistema exigem um motivo de cancelamento para cancelar um pedido de venda.</descricao>
</mensagem>
</mensagens>
</registro>
</registros>
<status>0</status>
</retorno>