Nuvem Shop Orders
GET
https://rest.api.mktlab.app/v1/nuvem-shop/orders
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único do pedido na plataforma NuvemShop. |
token | string | Token do pedido. |
store_id | string | ID da loja onde o pedido foi realizado. |
contact_email | string | E-mail de contato do cliente. |
contact_name | string | Nome do cliente. |
contact_phone | string | Telefone de contato do cliente. |
shipping_city | string | Cidade de entrega do pedido. |
shipping_province | string | Estado ou província de entrega do pedido. |
shipping_country | string | País de entrega do pedido. |
shipping_cost_owner | number | Valor do frete arcado pelo lojista. |
shipping_cost_customer | number | Valor do frete cobrado do cliente. |
subtotal | number | Subtotal do pedido (sem descontos e frete). |
discount | number | Valor total de desconto aplicado ao pedido. |
discount_coupon | number | Valor de desconto via cupom promocional. |
discount_gateway | number | Valor de desconto via meio de pagamento. |
total | number | Valor total do pedido (com descontos e frete). |
currency | string | Moeda do pedido (ex: BRL, USD). |
gateway_name | string | Nome do meio de pagamento utilizado. |
shipping | string | Tipo de envio selecionado. |
shipping_option | string | Opção específica de envio escolhida. |
created_at | Date | Data e hora em que o pedido foi criado (formato ISO 8601). |
updated_at | Date | Data e hora da última atualização do pedido (formato ISO 8601). |
completed_at | Date | Data e hora de conclusão do pedido (formato ISO 8601). |
next_action | string | Próxima ação a ser tomada no fluxo do pedido. |
customer_id | string | ID do cliente associado ao pedido. |
product_ids | string | IDs dos produtos incluídos no pedido (separados por vírgula). |
variant_id | string | ID da variante do produto. |
variant_price | string | Preço da variante do produto. |
compare_at_price | string | Preço original do produto antes do desconto. |
variant_promotional_price | string | Preço promocional aplicado à variante. |
variant_stock | string | Estoque disponível da variante. |
variant_sku | string | Código SKU da variante do produto. |
variant_barcode | string | Código de barras da variante do produto. |
variant_cost | string | Custo da variante do produto. |
payment_method | string | Método de pagamento utilizado no pedido. |
number | string | Número do pedido. |
storefront | string | Origem da venda (ex: loja online, marketplace). |
cancelled_at | Date | Data e hora em que o pedido foi cancelado (formato ISO 8601). |
closed_at | Date | Data e hora em que o pedido foi encerrado (formato ISO 8601). |
status | string | Status atual do pedido (ex: pago, cancelado, enviado). |
payment_status | string | Status do pagamento do pedido. |
shipping_status | string | Status da entrega do pedido. |
shipped_at | Date | Data e hora do envio do pedido (formato ISO 8601). |
paid_at | Date | Data e hora do pagamento do pedido (formato ISO 8601). |
utm_source | string | Fonte UTM da campanha de marketing. |
integration_id | string | ID da integração da plataforma com a conta NuvemShop. |
project_id | string | ID do projeto associado ao pedido. |
unit_id | string | ID da unidade de negócios associada ao pedido. |
document_id | string | ID do documento relacionado ao pedido. |
inserted_at | Date | Data e hora em que o registro foi inserido no sistema (formato ISO 8601). |
Requisição
Parâmetros de Consulta
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/nuvem-shop/orders' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"id": "1440600955",
"token": "9aca280814fbbb7db5fdefd39c1919e2ced7e494",
"store_id": "4331287",
"contact_email": "dados@v4company.com",
"contact_name": "Matheus Netto",
"contact_phone": "51996412983",
"shipping_city": null,
"shipping_province": null,
"shipping_country": null,
"shipping_cost_owner": "35.00",
"shipping_cost_customer": "35.00",
"subtotal": "2500.00",
"discount": "125.00",
"discount_coupon": "125.00",
"discount_gateway": "0.00",
"total": "2410.00",
"currency": "BRL",
"gateway_name": "not-provided",
"shipping": "draft",
"shipping_option": "Entraremos em contato com você para combinar a entrega!",
"created_at": "2024-02-27T19:28:42.000Z",
"updated_at": "2024-02-27T19:28:42.000Z",
"completed_at": "2024-02-27T19:28:42.000Z",
"next_action": "waiting_packing",
"customer_id": null,
"product_ids": null,
"variant_id": null,
"variant_price": null,
"compare_at_price": null,
"variant_promotional_price": null,
"variant_stock": null,
"variant_sku": null,
"variant_barcode": null,
"variant_cost": null,
"payment_method": null,
"number": "102",
"storefront": "form",
"cancelled_at": null,
"closed_at": null,
"status": "open",
"payment_status": "paid",
"shipping_status": "unpacked",
"shipped_at": null,
"paid_at": "2024-02-27T19:28:42.000Z",
"utm_source": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6aa079fc422d69bbbb",
"inserted_at": "2025-04-17T20:47:11.000Z"
},
{
"id": "1440550863",
"token": "66335e4616c3b886a56f5616bb15b521b43544ad",
"store_id": "4331287",
"contact_email": "matheus.netto@v4company.com",
"contact_name": "igor Lima",
"contact_phone": "51996412983",
"shipping_city": null,
"shipping_province": null,
"shipping_country": null,
"shipping_cost_owner": "0.00",
"shipping_cost_customer": "0.00",
"subtotal": "2500.00",
"discount": "0.00",
"discount_coupon": null,
"discount_gateway": "0.00",
"total": "2500.00",
"currency": "BRL",
"gateway_name": "not-provided",
"shipping": "draft",
"shipping_option": "Entraremos em contato com você para combinar a entrega!",
"created_at": "2024-02-27T17:36:33.000Z",
"updated_at": "2024-02-27T17:36:33.000Z",
"completed_at": "2024-02-27T17:36:33.000Z",
"next_action": "waiting_manual_confirmation",
"customer_id": null,
"product_ids": null,
"variant_id": null,
"variant_price": null,
"compare_at_price": null,
"variant_promotional_price": null,
"variant_stock": null,
"variant_sku": null,
"variant_barcode": null,
"variant_cost": null,
"payment_method": null,
"number": "101",
"storefront": "form",
"cancelled_at": null,
"closed_at": null,
"status": "open",
"payment_status": "pending",
"shipping_status": "unpacked",
"shipped_at": null,
"paid_at": null,
"utm_source": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6aa079fc422d69bbbb",
"inserted_at": "2025-04-17T20:47:11.000Z"
},
{
"id": "1440139784",
"token": "e8703d60e8824eee972d3f34fb814f94c85d506c",
"store_id": "4331287",
"contact_email": "igor.lima@v4company.com",
"contact_name": "Igor Lima",
"contact_phone": "51996412983",
"shipping_city": null,
"shipping_province": null,
"shipping_country": null,
"shipping_cost_owner": "50.00",
"shipping_cost_customer": "50.00",
"subtotal": "1250.00",
"discount": "125.00",
"discount_coupon": "125.00",
"discount_gateway": "0.00",
"total": "1175.00",
"currency": "BRL",
"gateway_name": "not-provided",
"shipping": "draft",
"shipping_option": "Entraremos em contato com você para combinar a entrega!",
"created_at": "2024-02-26T20:28:07.000Z",
"updated_at": "2024-02-27T17:35:49.000Z",
"completed_at": "2024-02-26T20:28:07.000Z",
"next_action": "waiting_shipment",
"customer_id": null,
"product_ids": null,
"variant_id": null,
"variant_price": null,
"compare_at_price": null,
"variant_promotional_price": null,
"variant_stock": null,
"variant_sku": null,
"variant_barcode": null,
"variant_cost": null,
"payment_method": null,
"number": "100",
"storefront": "form",
"cancelled_at": null,
"closed_at": null,
"status": "open",
"payment_status": "paid",
"shipping_status": "unshipped",
"shipped_at": null,
"paid_at": "2024-02-26T20:28:08.000Z",
"utm_source": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6aa079fc422d69bbbb",
"inserted_at": "2025-04-17T20:47:11.000Z"
},
{
"id": "1690274811",
"token": "1e5a6fdd52a516fb7c6516994dd79b13e23d57d5",
"store_id": "4331287",
"contact_email": "dados@v4company.com",
"contact_name": "Igor Lima",
"contact_phone": null,
"shipping_city": null,
"shipping_province": null,
"shipping_country": null,
"shipping_cost_owner": "10.00",
"shipping_cost_customer": "10.00",
"subtotal": "1250.00",
"discount": "0.00",
"discount_coupon": null,
"discount_gateway": "0.00",
"total": "1260.00",
"currency": "BRL",
"gateway_name": "not-provided",
"shipping": null,
"shipping_option": null,
"created_at": "2025-04-16T21:00:39.000Z",
"updated_at": "2025-04-16T21:00:39.000Z",
"completed_at": "2025-04-16T21:00:39.000Z",
"next_action": "close",
"customer_id": null,
"product_ids": null,
"variant_id": null,
"variant_price": null,
"compare_at_price": null,
"variant_promotional_price": null,
"variant_stock": null,
"variant_sku": null,
"variant_barcode": null,
"variant_cost": null,
"payment_method": null,
"number": "103",
"storefront": "form",
"cancelled_at": null,
"closed_at": null,
"status": "open",
"payment_status": "paid",
"shipping_status": "unpacked",
"shipped_at": null,
"paid_at": "2025-04-16T21:00:39.000Z",
"utm_source": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6aa079fc422d69bbbb",
"inserted_at": "2025-04-20T01:01:31.000Z"
}
],
"meta": {
"page": 1,
"limit": 500,
"total": 4,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
}Modificado em 2025-10-08 17:25:55