Incluir Forma de Frete API 2.0
Serviço destinado para a inclusão de uma forma de frete.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
Conteúdo do body
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| forma_frete (1) | object | obrigatório | Dados da forma de frete conforme layout |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| forma_frete | object | - | obrigatório | Elemento utilizado para representar uma forma de frete |
| forma_frete.id_forma_envio | int | - | obrigatório | ID da forma de envio |
| forma_frete.descricao_forma_frete | string | 30 | obrigatório | Nome da forma de frete |
| forma_frete.codigo | string | 30 | opcional | Código do serviço |
| forma_frete.codigo_externo (1) | string | 30 | opcional | Código externo da forma de frete. Código utilizado pelo gateway logístico vinculado |
| forma_frete.tipo_entrega (1) | int | - | opcional | Código do tipo de entrega conforme tabela de Tipos de entrega |
(1) - Somente será aceito caso a forma de envio possua integração com algum gateway logístico.
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) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados |
| retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.registro | object | - | condicional | Elemento com a forma de frete cadastrada |
| retorno.registro.id | int | - | condicional | ID da forma de frete cadastrada |
(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) - Estes campos somente serão informados caso o retorno contenha erros.
