Cadastro: Transportadoras Tabela no Protheus: SA4 Rotina no Protheus: MATA050.PRX
Objetivo: Retornar lista completa de Transportadoras
Exemplo do endpoint da API: Exemplo estrutural de uma requisição da API com esse endpoint: | <servidor>/api/fat/v1/carrier
| Exemplo "real" de uma requisição da API com esse endpoint: | http://localhost:4321/rest/api/fat/v1/carrier |
Estruturação: Trecho da URL | Significado | Exemplo real de conteúdo | Observação |
---|
<servidor> | Caminho do servidor com a porta e tipo (WS ou REST) | http://localhost:4321/rest | Alterável, depende de cada cliente | api | Sinalização que é uma API | api | Fixo, é definido pelo produto | fat | Sinalização que é uma API do Protheus Faturamento | fat | Fixo, é definido pelo produto | v1 | Versão da API do Protheus Faturamento | v1 | Fixo, é definido pelo produto (geralmente é alterável, porém, atualmente só há essa versão) | carrier | Sinalização que é a api para alterações de transportadora | carrier | Fixo, é definido pelo produto |
Estruturação do corpo (Body) da requisição: - Não há, pois é o método GET.
|
Se a API for concluída corretamente, será retornado:
{
"hasNext": false,
"items": [
{
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
}
]
} |
|
|
Se a API não for concluída corretamente, voltará com esse erro:
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URL para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
|
Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos e resultados"), onde nesse retorno, é exibido a lista de todas as transportadoras e seus detalhes.
Exemplo de como ficará no Protheus: - Não altera-se nada no Protheus, pois é o método GET.
|
|
|
Objetivo: Retornar a transportadora específica passada na URL
Exemplo do endpoint da API: Exemplo estrutural de uma requisição da API com esse endpoint: | <servidor>/api/fat/v1/carrier/<Internal Id Transportadora>
| Exemplo "real" de uma requisição da API com esse endpoint: | http://localhost:4321/rest/api/fat/v1/carrier/000001 |
Estruturação: Trecho da URL | Significado | Exemplo real de conteúdo | Observação |
---|
<servidor> | Caminho do servidor com a porta e tipo (WS ou REST) | http://localhost:4321/rest | Alterável, depende de cada cliente | api | Sinalização que é uma API | api | Fixo, é definido pelo produto | fat | Sinalização que é uma API do Protheus Faturamento | fat | Fixo, é definido pelo produto | v1 | Versão da API do Protheus Faturamento | v1 | Fixo, é definido pelo produto (geralmente é alterável, porém, atualmente só há essa versão) | carrier | Sinalização que é a api para alterações de transportadora | carrier | Fixo, é definido pelo produto | <Internal Id Transportadora> | Código da transportadora (A4_COD) no Protheus | 000001 | Alterável, depende de cada cliente, do código da transportadora no sistema dele |
Estruturação do corpo (Body) da requisição: - Não há, pois é o método GET.
|
Se a API for concluída corretamente, será retornado:
{
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
} |
|
|
Se a API não for concluída corretamente, voltará com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
|
Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos e resultados"), onde nesse retorno, é exibido a transportadora e seus detalhes.
Exemplo de como ficará no Protheus: - Não altera-se nada no Protheus, pois é o método GET.
|
|
|
|
Objetivo: Incluir a transportadora de acordo com os dados passados na requisição
Exemplo do endpoint da API: Exemplo estrutural de uma requisição da API com esse endpoint: | <servidor>/api/fat/v1/carrier
| Exemplo "real" de uma requisição da API com esse endpoint: | http://localhost:4321/rest/api/fat/v1/carrier |
Estruturação: Trecho da URL | Significado | Exemplo real de conteúdo | Observação |
---|
<servidor> | Caminho do servidor com a porta e tipo (WS ou REST) | http://localhost:4321/rest | Alterável, depende de cada cliente | api | Sinalização que é uma API | api | Fixo, é definido pelo produto | fat | Sinalização que é uma API do Protheus Faturamento | fat | Fixo, é definido pelo produto | v1 | Versão da API do Protheus Faturamento | v1 | Fixo, é definido pelo produto (geralmente é alterável, porém, atualmente só há essa versão) | carrier | Sinalização que é a api para alterações de transportadora | carrier | Fixo, é definido pelo produto |
Estruturação do corpo (Body) da requisição: {
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
}
|
|
Se a API for concluída corretamente, será retornado:
{
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
} |
|
|
Se a API não for concluída corretamente, voltará com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
|
Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos e resultados").
Exemplo de como ficará no Protheus: - Nova transportadora na tabela SA4.
|
|
|
|
Objetivo: Alterar a transportadora específica passada na URL
Exemplo do endpoint da API: Exemplo estrutural de uma requisição da API com esse endpoint: | <servidor>/api/fat/v1/carrier/<Internal Id Transportadora>
| Exemplo "real" de uma requisição da API com esse endpoint: | http://localhost:4321/rest/api/fat/v1/carrier/000001 |
Estruturação: Trecho da URL | Significado | Exemplo real de conteúdo | Observação |
---|
<servidor> | Caminho do servidor com a porta e tipo (WS ou REST) | http://localhost:4321/rest | Alterável, depende de cada cliente | api | Sinalização que é uma API | api | Fixo, é definido pelo produto | fat | Sinalização que é uma API do Protheus Faturamento | fat | Fixo, é definido pelo produto | v1 | Versão da API do Protheus Faturamento | v1 | Fixo, é definido pelo produto (geralmente é alterável, porém, atualmente só há essa versão) | carrier | Sinalização que é a api para alterações de transportadora | carrier | Fixo, é definido pelo produto | <Internal Id Transportadora> | Código da transportadora (A4_COD) no Protheus | 000001 | Alterável, depende de cada cliente, do código da transportadora no sistema dele |
Estruturação do corpo (Body) da requisição: {
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
} |
|
Se a API for concluída corretamente, será retornado:
{
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
} |
|
|
Se a API não for concluída corretamente, voltará com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
Se a API não for concluída corretamente, pode voltar com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
|
Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos e resultados"), onde nesse retorno, é exibido a transportadora e seus detalhes.
Exemplo de como ficará no Protheus: - A transportadora (A4_COD) passada na URL (Exemplo: 000001) foi alterada no Protheus.
|
|
|
|
Objetivo: Excluir a transportadora específica passada na URL
Exemplo do endpoint da API: Exemplo estrutural de uma requisição da API com esse endpoint: | <servidor>/api/fat/v1/carrier/<Internal Id Transportadora>
| Exemplo "real" de uma requisição da API com esse endpoint: | http://localhost:4321/rest/api/fat/v1/carrier/000001 |
Estruturação: Trecho da URL | Significado | Exemplo real de conteúdo | Observação |
---|
<servidor> | Caminho do servidor com a porta e tipo (WS ou REST) | http://localhost:4321/rest | Alterável, depende de cada cliente | api | Sinalização que é uma API | api | Fixo, é definido pelo produto | fat | Sinalização que é uma API do Protheus Faturamento | fat | Fixo, é definido pelo produto | v1 | Versão da API do Protheus Faturamento | v1 | Fixo, é definido pelo produto (geralmente é alterável, porém, atualmente só há essa versão) | carrier | Sinalização que é a api para alterações de transportadora | carrier | Fixo, é definido pelo produto | <Internal Id Transportadora> | Código da transportadora (A4_COD) no Protheus | 000001 | Alterável, depende de cada cliente, do código da transportadora no sistema dele |
Estruturação do corpo (Body) da requisição: |
Se a API for concluída corretamente, será retornado:
{
"BranchId": "D MG 01 ",
"CompanyInternalId": "T1D MG 01 000001",
"InternalId": "D MG 01 000001",
"Code": "000001",
"Name": "Transportadora Ex CO",
"ShortName": "Transportadora Ex",
"RegisterSituation": "1",
"governamentalInformation": [
{}
],
"address": [
{
"items": [
{
"address": "Rua, Avenida, Rodovia, etc. Ex.: Avenida Braz Leme",
"number": "string",
"complement": "string",
"city": {
"cityCode": "string",
"cityInternalId": "string",
"cityDescription": "string"
},
"district": "Casa Verde",
"state": {
"stateId": "string",
"stateInternalId": "string",
"stateDescription": "string"
},
"country": {
"countryCode": "string",
"countryInternalId": "string",
"countryDescription": "string"
},
"zipCode": "02022010",
"region": "Zona Norte",
"poBox": "string",
"mainAddress": true,
"shippingAddress": false,
"billingAddress": true
}
]
}
],
"listofComunicationInformation": [
{
"Type": "1",
"PhoneNumber": "string",
"PhoneExtension": "string",
"FaxNumber": "string",
"FaxNumberExtension": "string",
"HomePage": "string",
"Email": "string",
"DiallingCode": "string",
"InternationalDiallingCode": "string"
}
],
"CarrierType": "1"
} |
|
|
Se a API não for concluída corretamente, voltará com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
Se a API não for concluída corretamente, pode voltar com esse erro: {
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com",
"details": [
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "http://example.com"
}
]
} |
Explicação das tags de retorno: Tag | Tipo | Explicação | Obrigatoriedade |
---|
code | string | Código identificador do erro | Obrigatória, sempre estará presente no retorno | message | string | Descrição do erro por idioma | Obrigatória, sempre estará presente no retorno | detailedMessage | string | Mensagem técnica e mais detalhada do erro | Obrigatória, sempre estará presente no retorno | helpUrl | string | URI para documentação do erro | Não obrigatória, caso o erro não possuir documentação, não será retornado | details | object[] | Contém as tags code, message, detailedMessage e helpURL dentro de si | Não obrigatória |
|
|
|
Se tiver sucesso, será pego o retorno 200 (dúvidas, verificar aba acima "Retornos e resultados"), onde nesse retorno, é exibido a transportadora e seus detalhes.
Exemplo de como ficará no Protheus: - A transportadora (A4_COD) passada na URL (Exemplo: 000001) foi alterada no Protheus.
|
|
|
|
|
|