POST api/Encomendas?company={company}
Grava uma encomenda
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| company |
company |
string |
Default value is |
Body Parameters
Encomenda| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderIDCampo |
Campo onde se coloca o id da encomenda na loja (controlo de duplicados) |
string |
None. |
| OrderID |
ID da encomenda na loja (controlo de duplicados) |
string |
None. |
| Serie |
Serie do documento |
string |
None. |
| TipoDocumento |
Tipo do documento |
string |
None. |
| TipoEntidade |
Tipo da entidade |
string |
None. |
| Entidade |
Entidade |
string |
None. |
| CondicaoPagamento |
Condicao de pagamento |
string |
None. |
| ModoExpedicao |
Modo de expedicao |
string |
None. |
| ModoPagamento |
Modo de pagamento |
string |
None. |
| Portes |
Portes de envio |
decimal number |
None. |
| Cupao |
Codigo de cupao usado |
string |
None. |
| CupaoDesconto |
Desconto associado ao cupao em valor |
decimal number |
None. |
| DescontoFinanceiro |
Desconto financeiro em percentagem |
decimal number |
None. |
| DescontoCliente |
Desconto cliente em percentagem |
decimal number |
None. |
| Observacoes |
Observacoes |
string |
None. |
| Seccao |
Seccao |
string |
None. |
| Vendedor |
Vendedor |
string |
None. |
| MoradaFaturacao |
Morada de faturacao |
MoradaEncomenda |
None. |
| MoradaEntrega |
Morada de entrega |
MoradaEncomenda |
None. |
| Artigos |
Artigos |
Collection of ArtigoEncomenda |
None. |
| CamposExtra |
Campos de utilizador extra |
Collection of CampoUtilizador |
None. |
Request Formats
application/json, text/json
Sample:
{
"OrderIDCampo": "sample string 1",
"OrderID": "sample string 2",
"Serie": "sample string 3",
"TipoDocumento": "sample string 4",
"TipoEntidade": "sample string 5",
"Entidade": "sample string 6",
"CondicaoPagamento": "sample string 7",
"ModoExpedicao": "sample string 8",
"ModoPagamento": "sample string 9",
"Portes": 10.1,
"Cupao": "sample string 11",
"CupaoDesconto": 12.1,
"DescontoFinanceiro": 13.1,
"DescontoCliente": 14.1,
"Observacoes": "sample string 15",
"Seccao": "sample string 16",
"Vendedor": "sample string 17",
"MoradaFaturacao": {
"Nome": "sample string 1",
"Morada": "sample string 2",
"Morada2": "sample string 3",
"Cidade": "sample string 4",
"CodigoPostal": "sample string 5",
"Localidade": "sample string 6",
"Pais": "sample string 7",
"Contribuinte": "sample string 8"
},
"MoradaEntrega": {
"Nome": "sample string 1",
"Morada": "sample string 2",
"Morada2": "sample string 3",
"Cidade": "sample string 4",
"CodigoPostal": "sample string 5",
"Localidade": "sample string 6",
"Pais": "sample string 7",
"Contribuinte": "sample string 8"
},
"Artigos": [
{
"Artigo": "sample string 1",
"Quantidade": 2.1,
"PrecoUnitario": 3.1,
"Desconto": 4.1,
"Vendedor": "sample string 5"
},
{
"Artigo": "sample string 1",
"Quantidade": 2.1,
"PrecoUnitario": 3.1,
"Desconto": 4.1,
"Vendedor": "sample string 5"
}
],
"CamposExtra": [
{
"Campo": "sample string 1",
"Valor": "sample string 2"
},
{
"Campo": "sample string 1",
"Valor": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<Encomenda xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BeevoPrimaveraWS.Models">
<Artigos>
<ArtigoEncomenda>
<Artigo>sample string 1</Artigo>
<Desconto>4.1</Desconto>
<PrecoUnitario>3.1</PrecoUnitario>
<Quantidade>2.1</Quantidade>
<Vendedor>sample string 5</Vendedor>
</ArtigoEncomenda>
<ArtigoEncomenda>
<Artigo>sample string 1</Artigo>
<Desconto>4.1</Desconto>
<PrecoUnitario>3.1</PrecoUnitario>
<Quantidade>2.1</Quantidade>
<Vendedor>sample string 5</Vendedor>
</ArtigoEncomenda>
</Artigos>
<CamposExtra>
<CampoUtilizador>
<Campo>sample string 1</Campo>
<Valor>sample string 2</Valor>
</CampoUtilizador>
<CampoUtilizador>
<Campo>sample string 1</Campo>
<Valor>sample string 2</Valor>
</CampoUtilizador>
</CamposExtra>
<CondicaoPagamento>sample string 7</CondicaoPagamento>
<Cupao>sample string 11</Cupao>
<CupaoDesconto>12.1</CupaoDesconto>
<DescontoCliente>14.1</DescontoCliente>
<DescontoFinanceiro>13.1</DescontoFinanceiro>
<Entidade>sample string 6</Entidade>
<ModoExpedicao>sample string 8</ModoExpedicao>
<ModoPagamento>sample string 9</ModoPagamento>
<MoradaEntrega>
<Cidade>sample string 4</Cidade>
<CodigoPostal>sample string 5</CodigoPostal>
<Contribuinte>sample string 8</Contribuinte>
<Localidade>sample string 6</Localidade>
<Morada>sample string 2</Morada>
<Morada2>sample string 3</Morada2>
<Nome>sample string 1</Nome>
<Pais>sample string 7</Pais>
</MoradaEntrega>
<MoradaFaturacao>
<Cidade>sample string 4</Cidade>
<CodigoPostal>sample string 5</CodigoPostal>
<Contribuinte>sample string 8</Contribuinte>
<Localidade>sample string 6</Localidade>
<Morada>sample string 2</Morada>
<Morada2>sample string 3</Morada2>
<Nome>sample string 1</Nome>
<Pais>sample string 7</Pais>
</MoradaFaturacao>
<Observacoes>sample string 15</Observacoes>
<OrderID>sample string 2</OrderID>
<OrderIDCampo>sample string 1</OrderIDCampo>
<Portes>10.1</Portes>
<Seccao>sample string 16</Seccao>
<Serie>sample string 3</Serie>
<TipoDocumento>sample string 4</TipoDocumento>
<TipoEntidade>sample string 5</TipoEntidade>
<Vendedor>sample string 17</Vendedor>
</Encomenda>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
EncomendaResultado| Name | Description | Type | Additional information |
|---|---|---|---|
| Sucesso |
Successo |
boolean |
None. |
| NumeroDocumento |
Numero do documento gerado |
integer |
None. |
| MensagemErro |
Mensagem de erro |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Sucesso": true,
"NumeroDocumento": 2,
"MensagemErro": "sample string 3"
}
application/xml, text/xml
Sample:
<EncomendaResultado xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BeevoPrimaveraWS.Models"> <MensagemErro>sample string 3</MensagemErro> <NumeroDocumento>2</NumeroDocumento> <Sucesso>true</Sucesso> </EncomendaResultado>