get
https://{environment}.app/orders/
Use esta api para buscar os detalhes de um pedido
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id* | number | Identificador único do pedido |
| orderNumber* | string | Identificador único do pedido no sistema externo |
| sellerOrderNumber | string | Identificador do pedido na loja |
| createdOn | datetime | Data em que o pedido foi criado no sistema externo |
| createdAt* | datetime | Data em que o pedido foi criado em nossa plataforma (Fuso horário UTC) |
| updatedAt | datetime | Data da última atualização do pedido |
| inMultipleStores | boolean | Flag que indica se o pedido foi dividido para mais de uma loja |
| storeId (depreciado)* | number | Identificador da loja responsável pelo pedido |
| storeName (depreciado)* | string | Nome da loja responsável pelo pedido |
| express* | boolean | Flag que indica se o pedido é expresso |
| single* | boolean | Flag que indica se o pedido tem apenas um item |
| status* | string | Status do pedido (Active ou Cancelled) |
| progress* | string | Progresso do pedido (conforme descrito na tabela) |
| instructions | string | Preferências do consumidor |
| totalValue | number | Valor total do pedido |
| cancelationCreatedAt | datetime | Data em que o pedido foi cancelado |
| cancelationJustificative | string | Justificativa do cancelamento |
| confirmationRequired (depreciado) | enum | Indica quais são as confirmações exigidas pelo pedido (None = 0, Document = 1, Stock = 2, Ready = 4) |
| confirmationsRequired | array | Indica quais são as confirmações esperadas no pedido (None, Document, Stock ou Ready) |
| confirmedAt | datetime | Data em que o pedido foi confirmado |
| - shipping | object | Objeto com dados de entrega |
| addressId | number | Identificador do endereço |
| name | string | Nome do consumidor |
| string | E-mail do consumidor | |
| document | string | Documento do consumidor |
| phone | string | Telefone do consumidor |
| postalCode | string | CEP do endereço de entrega |
| addressLine | string | Endereço de entrega |
| reference | string | Informação útil para ajudar o entregador |
| neighborhood | string | Bairo do endereço de entrega |
| number | string | Númedo do endereço de entrega |
| complement | string | Complemento do endereço de entrega |
| city | string | Cidade do endereço de entrega |
| state | string | Estado do endereço de entrega |
| formattedAddress | string | Endereço de entrega formatado |
| lat | number | Latitude do endereço de entrega |
| lon | number | Longitude do endereço de entrega |
| - items | array | Lista de itens |
| id* | number | Identificador único do item |
| uniqueId* | string | Identificador único UUID |
| deliveryDate* | datetime | Data da previsão de entrega |
| endDeliveryDate | datetime | Data da previsão de entrega com horário final |
| deliveryModeName | string | Modalidade de entrega |
| pickupVerificationCode | string | Código de verificação para retirada |
| deliveryType* | string | Tipo de entrega |
| express* | boolean | Flag que indica se o pedido é expresso |
| keyword | string | Palavras chaves |
| unitMeasure | string | Unidade de medida |
| quantity* | number | Quantidade do item |
| quantitySeparated | number | Quantidade separada do item |
| quantityCheckedOut | number | Quantidade conferida |
| quantityShippedOut | number | Quantidade embalada |
| shipmentFrom* | string | Identificador da loja responsável do item |
| status | string | Status do item (Pending, Successfully, Unsuccessfully, Cancelled) |
| cancelation | string | Justificativa do cancelamento do item |
| requiresLocationScan | boolean | |
| extras | object | Contém informações adicionais do item |
| discount | number | Desconto do item |
| - changedPrices | array | Lista de itens com mudança preço |
| sku | string | Identificador do produto |
| weight | number | Peso do item |
| unitValue | number | Valor unitário |
| discount | number | Desconto |
| newUnitPrice | number | Novo valor unitário |
| newDiscount | number | Novo desconto |
| - replacements | array | Lista de trocas do item |
| checkoutItemId | number | Identificador do item de conferência |
| quantity | number | Quantidade do novo item |
| price | number | Valor unitário do novo item |
| discount | number | Desconto do novo item |
| - product* | object | Objeto contendo informações sobre o produto |
| name* | string | Nome do produto |
| key* | string | Identificador único do produto em nossa plataforma |
| ean* | string | Código de barras do produto (GTIN) |
| sku* | string | Identificador do produto |
| type | string | Tipo do produto |
| subType | string | Subtipo do produto |
| width | number | Largura do produto |
| height | number | Altura do produto |
| weight | number | Peso do produto |
| - pictures | array | Lista de imagens do produto |
| url | string | URL da imagem do produto |
| - shippingCompany | object | Objeto contendo informações da transportadora |
| id | number | Identificador único da transportadora |
| name | string | Nome da transportadora |
| externalCode | string | Código único da transportdora |
| logoUrl | string | Url do logo da transportadora |
| companyOption | enum | Código da integração da transportadora |
| federalId | string | CNPJ da transportadora |
| extras | object | Informações adicionais da transportadora |
| packingListEnabled | boolean | Flag que indica se a transportadora requer romaneio |
| allowResent | boolean | Flag que indica se a transportadora suportar reenvio do pedido |
| - payments | array | Lista de meios de pagamento |
| type | enum | Tipo do pagamento (cash, invoice, card, instantPayment, digitalWallet, giftCard, debit, ifood, rappi, cashback, other) |
| paymentMethod | string | Meio de pagamento informado no pedido |
| installmentCount | number | Número de parcelas |
| installmentValue | number | Valor da parcela |
| value | number | Valor do pagamento |
| transactionId | string | Identificador da transação de pagamento |
| maskedCardNumber | string | Número do cartão de crédito mascarado |
| extras | object | Objeto contendo informações adicionais sobre o meio de pagamento, ex. nsu, tid, acquirer, pspReference e etc |
| creditCardBrand | string | Bandeira do cartão de crédito |
| - invoice | object | Objeto contendo informações sobre o faturamento |
| key | string | Chave do documento fiscal |
| number | string | Número do documento fiscal |
| serialNumber | string | Número de série do documento fiscal |
| fiscalCode | string | CFOP do documento fiscal |
| totalValue | number | Valor total faturado |
| totalProductsValue | number | Valor total dos itens faturados |
| issuedAt | datetime | Data em que o faturamento ocorreu (Fuso horário UTC) |
| pointOfSaleId | string | Identificador do pedido no PDV/ERP |
| totalFreight | number | Total do frete |
| totalDiscount | number | Total do desconto |
| totalTaxes | number | Total das taxas |
| trackingCode (depreciado)* | string | Identificador da loja no sistema externo |
| deliveryDate | datetime | Data da entrega do pedido |
| sourceType | string | Identificador do canal do pedido (Default, Vtex, Rappi, Ifood) |
| extrasData | object | Objeto contendo informações adicionais do pedido |
| - store | object | Objeto com informações da loja |
| id | string | Identificador da loja |
| code | string | Identificador da loja no sistema externo |
| name | string | Nome da loja |
| - changes | object | Objeto que contém informações sobre as trocas |
| orderItemId | number | Id único do item, esse id deve ser cruzado com o id do array Items |
| discount | number | Desconto total do item |
| finalWeight | number | Peso final do item |
| quantity | number | Quantidade do item |
| unitValue | number | Valor unitário do item |
| status | enum | Inserted, Removed ou Canceled |
| - product | object | Objeto contendo informações do produto |
| name | string | Nome do produto |
| key | string | Identificador único do produto em nossa plataforma |
| sku | string | Identificador do produto |