GET api/v2/pedido/getdetalhes?PedidoId={PedidoId}&TenantId={TenantId}&RegistroPedido={RegistroPedido}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PedidoId | integer |
Required |
|
TenantId | globally unique identifier |
None. |
|
RegistroPedido | string |
None. |
Body Parameters
None.
Response Information
Resource Description
GetDetalhesPedidoResultName | Description | Type | Additional information |
---|---|---|---|
TituloPedido | string |
None. |
|
ObservacoesAdicionais | string |
None. |
|
CanalCriacaoId | integer |
None. |
|
PedidoId | integer |
None. |
|
NumeroPedido | integer |
None. |
|
DataCriacao | date |
None. |
|
StatusPedidoId | integer |
None. |
|
Anexos | Collection of AnexoPedidoResult |
None. |
|
StatusPedidoDescricao | string |
None. |
|
PrecoTotal | decimal number |
None. |
|
Itens | Collection of GetItensItemResult |
None. |
|
ValorItens | decimal number |
None. |
|
ValorAdicional | decimal number |
None. |
|
ValorTotal | decimal number |
None. |
|
ValorDesconto | decimal number |
None. |
|
TipoEnderecoId | integer |
None. |
|
Endereco | string |
None. |
|
Cidade | string |
None. |
|
Estado | string |
None. |
|
Cep | string |
None. |
|
Numero | string |
None. |
|
Bairro | string |
None. |
|
Complemento | string |
None. |
|
TipoLiberacaoPagamento | integer |
None. |
|
StatusPedidoPago | integer |
None. |
|
TipoRetiradaPedido | integer |
None. |
|
FormaPagamento_Id | integer |
None. |
|
ValorPagamento | decimal number |
None. |
|
StatusMensagensPedidoId | integer |
None. |
|
UltimaMensagem | string |
None. |
|
PagamentoInfo | PagamentoInfo |
None. |
|
ClientePedido | ClientePedido |
None. |
|
Succeeded | boolean |
None. |
|
Errors | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "TituloPedido": "sample string 1", "ObservacoesAdicionais": "sample string 2", "CanalCriacaoId": 3, "PedidoId": 4, "NumeroPedido": 5, "DataCriacao": "2024-09-08T00:53:38.186143+00:00", "StatusPedidoId": 7, "Anexos": [ { "AnexoPedidoId": 1, "ConteudoTexto": "sample string 2", "TipoAnexoId": 3 }, { "AnexoPedidoId": 1, "ConteudoTexto": "sample string 2", "TipoAnexoId": 3 } ], "StatusPedidoDescricao": "sample string 8", "PrecoTotal": 1.0, "Itens": [ { "ItemId": 1, "Descricao": "sample string 2", "PrecoUnitario": 1.0, "Quantidade": 3, "PrecoTotal": 1.0 }, { "ItemId": 1, "Descricao": "sample string 2", "PrecoUnitario": 1.0, "Quantidade": 3, "PrecoTotal": 1.0 } ], "ValorItens": 1.0, "ValorAdicional": 1.0, "ValorTotal": 1.0, "ValorDesconto": 1.0, "TipoEnderecoId": 9, "Endereco": "sample string 10", "Cidade": "sample string 11", "Estado": "sample string 12", "Cep": "sample string 13", "Numero": "sample string 14", "Bairro": "sample string 15", "Complemento": "sample string 16", "TipoLiberacaoPagamento": 17, "StatusPedidoPago": 18, "TipoRetiradaPedido": 19, "FormaPagamento_Id": 1, "ValorPagamento": 1.0, "StatusMensagensPedidoId": 20, "UltimaMensagem": "sample string 21", "PagamentoInfo": { "ValorPagamento": 1.0, "AdditionalInfo": "sample string 2", "GatewayPagamentoId": 1 }, "ClientePedido": { "EnderecosCliente": [ { "Id": 1, "Ender": "sample string 2", "EndNr": "sample string 3", "Complemento": "sample string 4", "Bairro": "sample string 5", "Cidade": "sample string 6", "NrCep": "sample string 7", "Uf": "sample string 8" }, { "Id": 1, "Ender": "sample string 2", "EndNr": "sample string 3", "Complemento": "sample string 4", "Bairro": "sample string 5", "Cidade": "sample string 6", "NrCep": "sample string 7", "Uf": "sample string 8" } ], "Id": 1, "TenantId": "39694a44-f168-4f13-9e44-5080fa7f1bc7", "Nome": "sample string 3", "CpfCnpj": "sample string 4", "Email": "sample string 5", "DataNascimento": "2024-09-08T00:53:38.186143+00:00" }, "Succeeded": true, "Errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<GetDetalhesPedidoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models"> <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Errors> <Succeeded>true</Succeeded> <Anexos> <AnexoPedidoResult> <AnexoPedidoId>1</AnexoPedidoId> <ConteudoTexto>sample string 2</ConteudoTexto> <TipoAnexoId>3</TipoAnexoId> </AnexoPedidoResult> <AnexoPedidoResult> <AnexoPedidoId>1</AnexoPedidoId> <ConteudoTexto>sample string 2</ConteudoTexto> <TipoAnexoId>3</TipoAnexoId> </AnexoPedidoResult> </Anexos> <Bairro>sample string 15</Bairro> <CanalCriacaoId>3</CanalCriacaoId> <Cep>sample string 13</Cep> <Cidade>sample string 11</Cidade> <ClientePedido> <CpfCnpj xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">sample string 4</CpfCnpj> <DataNascimento xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">2024-09-08T00:53:38.186143+00:00</DataNascimento> <Email xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">sample string 5</Email> <Id xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">1</Id> <Nome xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">sample string 3</Nome> <TenantId xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">39694a44-f168-4f13-9e44-5080fa7f1bc7</TenantId> <EnderecosCliente xmlns:d3p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result"> <d3p1:GetClientePagExpressResult.EnderecoClientePagExpress> <d3p1:Bairro>sample string 5</d3p1:Bairro> <d3p1:Cidade>sample string 6</d3p1:Cidade> <d3p1:Complemento>sample string 4</d3p1:Complemento> <d3p1:EndNr>sample string 3</d3p1:EndNr> <d3p1:Ender>sample string 2</d3p1:Ender> <d3p1:Id>1</d3p1:Id> <d3p1:NrCep>sample string 7</d3p1:NrCep> <d3p1:Uf>sample string 8</d3p1:Uf> </d3p1:GetClientePagExpressResult.EnderecoClientePagExpress> <d3p1:GetClientePagExpressResult.EnderecoClientePagExpress> <d3p1:Bairro>sample string 5</d3p1:Bairro> <d3p1:Cidade>sample string 6</d3p1:Cidade> <d3p1:Complemento>sample string 4</d3p1:Complemento> <d3p1:EndNr>sample string 3</d3p1:EndNr> <d3p1:Ender>sample string 2</d3p1:Ender> <d3p1:Id>1</d3p1:Id> <d3p1:NrCep>sample string 7</d3p1:NrCep> <d3p1:Uf>sample string 8</d3p1:Uf> </d3p1:GetClientePagExpressResult.EnderecoClientePagExpress> </EnderecosCliente> </ClientePedido> <Complemento>sample string 16</Complemento> <DataCriacao>2024-09-08T00:53:38.186143+00:00</DataCriacao> <Endereco>sample string 10</Endereco> <Estado>sample string 12</Estado> <FormaPagamento_Id>1</FormaPagamento_Id> <Itens> <GetItensItemResult> <Descricao>sample string 2</Descricao> <ItemId>1</ItemId> <PrecoTotal>1</PrecoTotal> <PrecoUnitario>1</PrecoUnitario> <Quantidade>3</Quantidade> </GetItensItemResult> <GetItensItemResult> <Descricao>sample string 2</Descricao> <ItemId>1</ItemId> <PrecoTotal>1</PrecoTotal> <PrecoUnitario>1</PrecoUnitario> <Quantidade>3</Quantidade> </GetItensItemResult> </Itens> <Numero>sample string 14</Numero> <NumeroPedido>5</NumeroPedido> <ObservacoesAdicionais>sample string 2</ObservacoesAdicionais> <PagamentoInfo> <AdditionalInfo>sample string 2</AdditionalInfo> <GatewayPagamentoId>1</GatewayPagamentoId> <ValorPagamento>1</ValorPagamento> </PagamentoInfo> <PedidoId>4</PedidoId> <PrecoTotal>1</PrecoTotal> <StatusMensagensPedidoId>20</StatusMensagensPedidoId> <StatusPedidoDescricao>sample string 8</StatusPedidoDescricao> <StatusPedidoId>7</StatusPedidoId> <StatusPedidoPago>18</StatusPedidoPago> <TipoEnderecoId>9</TipoEnderecoId> <TipoLiberacaoPagamento>17</TipoLiberacaoPagamento> <TipoRetiradaPedido>19</TipoRetiradaPedido> <TituloPedido>sample string 1</TituloPedido> <UltimaMensagem>sample string 21</UltimaMensagem> <ValorAdicional>1</ValorAdicional> <ValorDesconto>1</ValorDesconto> <ValorItens>1</ValorItens> <ValorPagamento>1</ValorPagamento> <ValorTotal>1</ValorTotal> </GetDetalhesPedidoResult>