---
# System prepended metadata

title: Integração de pedidos

---

# Integração de pedidos

Esse documento descreve como enviar seus pedidos para a plataforma de delivery da Logstore.

Para integrar seus pedidos, envie uma solicitação http POST para o endereço [api] (https://homolog.api.nexp.app/v2/orders). Esta api é assincrona e seu resultado será disponibilizado para o cliente via Webhook, conforme descrito em nossa documentação online [documentação](https://nexp.readme.io/reference#confirmacao-de-pedido).


## Autenticação

Todas as solicitações devem incluir o header *x-api-key* com a chave que será compartilhada por nosso time de atendimento.


## Corpo da solicitação

O corpo da solicitação deve respeitar o formato abaixo:

```
{
 "header":{
    "orderNumber":"1dd8d51a8ba54e789ff51087b6a1d6a2",
    "creationDate":"2021-05-07T01:36:46.4088088Z",
    "status":"payment-approved",
    "totalValue":23.0,
    "totalFreight":24.0,
    "totalDiscount":25.0,
    "totalTaxes":26.0,
    "instructions": "enviar troco para R$ 100"
 },
 "receiver":{
    "name":"John Doe",
    "email":"john.doe@logstore.com.br",
    "document":"01234567890"
 },
 "shippingAddress":{
    "addressLine1":"Avenida Angélica",
    "addressLine2":"sala 301 3 andar",
    "number":"2529",
    "city":"São Paulo",
    "state":"SP",
    "postalCode":"01227-200",
    "neighborhood": "Consolação",
    "phone":"11 5555-5555",
    "lat": -23.5539458,
    "lon": -46.6623786
 },
 "items":[
    {
       "id": "c6cd7364-c6c8-417b-a1f3-2afb1cb40d1e",
       "productSku":"sku",
       "productEAN":"ean",
       "productName":"product full",
       "productUnitMeasure":"un",
       "productQuantity":20,
       "storeCode":"001",
       "deliveryDateItem":"2021-05-08T01:36:46.4092356Z",
       "key": "0009",
       "freightValue":1.0,
       "unitValue":2.0,
       "taxes":3.0,
       "discount":4.0,
       "instructions": "prefiro produtos frescos"
    }
 ],
 "payments":[
    {
       "paymentMethod":"creditCard",
       "installmentCount":2,
       "installmentValue":20.00,
       "paymentId":"1245",
       "value":40.0,
       "tid":"cbe154ec-750b-4932-aa88-ffe14975ef12"
    }
 ]
}
```

A tabela abaixo descreve os campos do corpo da solicitação para integrar pedidos.


| Campo              | Tipo     | Tamanho | Descrição                                                          |
| ------------------ | -------- | ------- | ------------------------------------------------------------------ |
| orderNumber        | string   | 32      | ID do pedido                                                       |
| creationDate       | datetime |         | data de criação do pedido no formato ISO-8601 UTC                  |
| status             | string   | 32      | status do pedido                                                   |
| totalValue         | decimal  |         | valor total do pedido                                              |
| totalFreight       | decimal  |         | valor total do frete                                               |
| totalDiscount      | decimal  |         | valor total dos descontos                                          |
| totalTaxes         | decimal  |         | valor total dos impostos                                           |
| name               | string   | 128     | nome do destinatário                                               |
| email              | string   | 64      | email do destinatário                                              |
| document           | string   | 32      | cpf do destinatário                                                |
| addressLine1       | string   | 200     | endereço de entrega                                                |
| addressLine2       | string   | 120     | complemento do endereço de entrega                                 |
| number             | string   | 16      | número do endereço de entrega                                      |
| city               | string   | 64      | cidade do endereço de entrega                                      |
| state              | string   | 2       | estado do endereço de entrega                                      |
| postalCode         | string   | 9       | CEP do endereço de entrega                                         |
| neighborhood       | string   | 64      | bairro do endereço de entrega                                      |
| phone              | string   | 20      | telefone de contato                                                |
| lat                | decimal  |         | latitude do endereço de entrega                                    |
| lon                | decimal  |         | longitude do endereço de entrega                                   |
| id                 | string   | 36      | id do item de pedido                                               |
| productSku         | string   | 32      | sku do produto                                                     |
| productEAN         | string   | 32      | ean do produto                                                     |
| key                | string   | 32      | id do produto                                                      |
| productUnitMeasure | string   | 4       | unidade de medida do produto                                       |
| productQuantity    | decimal  |         | quantidade de itens                                                |
| storeCode          | string   | 10      | id da loja responsável por processar o item do pedido              |
| deliveryDateItem   | datetime |         | data de entrega do pedido no formato ISO-8601 UTC                  |
| freightValue       | decimal  |         | valor do frete do item                                             |
| unitValue          | decimal  |         | valor unitário de venda do item                                    |
| taxes              | decimal  |         | valor dos impostos item                                            |
| discount           | decimal  |         | valor do desconto                                                  |
| paymentMethod      | string   | 64      | descrição do meio de pagamento, ex creditCard, debitCard, giftCard |
| installmentCount   | integer  |         | quantidade de parcelas do pagamento                                |
| installmentValue   | decimal  |         | valor da parcela do pagamento                                      |
| paymentId          | integer  |         | id do meio de pagamento                                            |
| value              | decimal  |         | valor pago por este meio de pagamento                              |
| tid                | string   | 64      | id da transação de pagamento                                       |


