Mediahub Rest API
  1. Nuvem Shop
Mediahub Rest API
  • Introdução
  • API Reference
    • Facebook Ads
      • Accounts
      • Ads [Ad Level]
      • Ads Config [Ad Level]
      • Ads [Adset Level]
      • Ads Config [Adset Level]
      • Ads [Campaign Level]
      • Ads Config [Campaign Level]
      • Ads Actions
      • Ads Gender/Age
      • Ads Region
      • Ads Platform
      • Creatives [Deprecated]
      • Creatives with Ad
    • Google Ads
      • Accounts
      • Ads Conversions
      • Ads [Ad Group]
      • Ads [Conversion Segmented Ad Group]
      • Ads [Ad Group Ads]
      • Ads Criterion [Ad Group Ads]
      • Ads [Conversion Segmented Ad Group Ads]
      • Ads [Campaigns]
      • Ads Criterion [Campaigns]
      • Ads [Conversion Segmented Campaigns]
      • Ads Age Dimension
      • Ads Gender Dimension
      • Ads Geographic Dimension
      • Ads Keywords Dimension
    • Google Analytics
      • Google Analytics Customers
      • Google Analytics Custom Events
      • Google Analytics Events
      • Google Analytics Products
      • Google Analytics Sessions
      • Google Analytics Transactions
    • Instagram Insights
      • Instagram Age Insights
      • Instagram City Insights
      • Instagram Gender Insights
      • instagram Media Details
      • Instagram Media Insights
      • Instagram Profile
      • Instagram Profile Insights
    • TikTok
      • TikTok Budget
      • TikTok Demographic
      • TikTok Group Budget
      • TikTok Info
      • TikTok Region
    • Linkedin
      • Linkedin Statistics
      • Linkedin Accounts Campaigns
      • Linkedin Conversions Tracking
    • Bitrix
      • Bitrix Contacts
      • Bitrix Deals
      • Bitrix Won Deals
      • Bitrix Leads History
    • Kommo
      • Kommo Contacts
      • Kommo Leads
      • Kommo Pipelines
      • Kommo Users
    • Loja Integrada
      • Loja Integrada Customers
      • Loja Integrada Orders
      • Loja Integrada Products
    • Nuvem Shop
      • Nuvem Shop Customers
        GET
      • Nuvem Shop Orders
        GET
      • Nuvem Shop Products
        GET
    • Pipedrive
      • Pipedrive Deals
      • Pipedrive Leads
      • Pipedrive Lead Sources
      • Pipedrive People
      • Pipedrive Pipelines
      • Pipedrive Pipeline Stages
      • Pipedrive Products
      • Pipedrive Users
    • Rd Station
      • Rd Station Deal Stages
      • Rd Station Deals
      • Rd Station Products
    • Shopify
      • Shopify Customers
      • Shopify Orders
      • Shopify Orders Items
      • Shopify Products
    • Tray
      • Tray Customers
      • Tray Orders
      • Tray Products
    • Unbounce
      • Unbounce Leads
    • Vtex
      • Vtex Customers
      • Vtex Orders
      • Vtex Products
    • Investimentos de Mídia
      • Investimentos de Mídia
    • Integrações
      • Integrações
  1. Nuvem Shop

Nuvem Shop Orders

GET
https://rest.api.mktlab.app/v1/nuvem-shop/orders

Resposta#

A resposta retorna uma lista de dados dos pedidos da NuvemShop com os seguintes campos:
CampoTipoDescrição
idstringID único do pedido na plataforma NuvemShop.
tokenstringToken do pedido.
store_idstringID da loja onde o pedido foi realizado.
contact_emailstringE-mail de contato do cliente.
contact_namestringNome do cliente.
contact_phonestringTelefone de contato do cliente.
shipping_citystringCidade de entrega do pedido.
shipping_provincestringEstado ou província de entrega do pedido.
shipping_countrystringPaís de entrega do pedido.
shipping_cost_ownernumberValor do frete arcado pelo lojista.
shipping_cost_customernumberValor do frete cobrado do cliente.
subtotalnumberSubtotal do pedido (sem descontos e frete).
discountnumberValor total de desconto aplicado ao pedido.
discount_couponnumberValor de desconto via cupom promocional.
discount_gatewaynumberValor de desconto via meio de pagamento.
totalnumberValor total do pedido (com descontos e frete).
currencystringMoeda do pedido (ex: BRL, USD).
gateway_namestringNome do meio de pagamento utilizado.
shippingstringTipo de envio selecionado.
shipping_optionstringOpção específica de envio escolhida.
created_atDateData e hora em que o pedido foi criado (formato ISO 8601).
updated_atDateData e hora da última atualização do pedido (formato ISO 8601).
completed_atDateData e hora de conclusão do pedido (formato ISO 8601).
next_actionstringPróxima ação a ser tomada no fluxo do pedido.
customer_idstringID do cliente associado ao pedido.
product_idsstringIDs dos produtos incluídos no pedido (separados por vírgula).
variant_idstringID da variante do produto.
variant_pricestringPreço da variante do produto.
compare_at_pricestringPreço original do produto antes do desconto.
variant_promotional_pricestringPreço promocional aplicado à variante.
variant_stockstringEstoque disponível da variante.
variant_skustringCódigo SKU da variante do produto.
variant_barcodestringCódigo de barras da variante do produto.
variant_coststringCusto da variante do produto.
payment_methodstringMétodo de pagamento utilizado no pedido.
numberstringNúmero do pedido.
storefrontstringOrigem da venda (ex: loja online, marketplace).
cancelled_atDateData e hora em que o pedido foi cancelado (formato ISO 8601).
closed_atDateData e hora em que o pedido foi encerrado (formato ISO 8601).
statusstringStatus atual do pedido (ex: pago, cancelado, enviado).
payment_statusstringStatus do pagamento do pedido.
shipping_statusstringStatus da entrega do pedido.
shipped_atDateData e hora do envio do pedido (formato ISO 8601).
paid_atDateData e hora do pagamento do pedido (formato ISO 8601).
utm_sourcestringFonte UTM da campanha de marketing.
integration_idstringID da integração da plataforma com a conta NuvemShop.
project_idstringID do projeto associado ao pedido.
unit_idstringID da unidade de negócios associada ao pedido.
document_idstringID do documento relacionado ao pedido.
inserted_atDateData e hora em que o registro foi inserido no sistema (formato ISO 8601).

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Respostas

🟢200Nuvem Shop Orders
application/json
Body

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
Página anterior
Nuvem Shop Customers
Próxima página
Nuvem Shop Products
Built with