Mediahub Rest API
  1. Tray
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
      • Nuvem Shop Orders
      • Nuvem Shop Products
    • 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
        GET
      • Tray Orders
        GET
      • Tray Products
        GET
    • Unbounce
      • Unbounce Leads
    • Vtex
      • Vtex Customers
      • Vtex Orders
      • Vtex Products
    • Investimentos de Mídia
      • Investimentos de Mídia
    • Integrações
      • Integrações
  1. Tray

Tray Orders

GET
https://rest.api.mktlab.app/v1/tray/orders

Resposta#

A resposta retorna uma lista de pedidos da Tray, com os seguintes campos:
CampoTipoDescrição
statusstringStatus do pedido, como "Em andamento", "Cancelado", "Concluído".
idstringID único do pedido.
dateDateData de criação do pedido.
hourstringHora em que o pedido foi criado.
customer_idstringID único do cliente associado ao pedido.
partial_totalnumberTotal parcial do pedido, antes de impostos e descontos.
taxesnumberValor total dos impostos aplicados ao pedido.
discountnumberValor total do desconto aplicado ao pedido.
point_salestringPonto de venda ou identificador da loja onde o pedido foi realizado.
shipmentstringMétodo de envio escolhido para o pedido.
shipment_valuenumberValor do frete ou envio do pedido.
shipment_dateDateData de envio do pedido.
deliveredbooleanIndica se o pedido foi entregue (true) ou não (false).
delivered_statusstringStatus da entrega do pedido (ex: "Entregue", "Em trânsito", "Aguardando entrega").
shipping_cancelledbooleanIndica se o envio foi cancelado.
store_notestringObservações da loja sobre o pedido.
customer_notestringObservações do cliente sobre o pedido.
partner_idstringID do parceiro responsável pelo pedido (se aplicável).
discount_couponstringCódigo do cupom de desconto utilizado no pedido (se aplicável).
client_ipstringIP do cliente no momento da realização do pedido.
payment_method_ratenumberTaxa do método de pagamento utilizado para o pedido.
installmentstringNúmero de parcelas do pagamento, se for parcelado.
value_1numberValor adicional ou relacionado a uma categoria do pedido.
sending_codestringCódigo de envio gerado para o pedido.
sending_dateDateData em que o pedido foi enviado.
billing_addressstringEndereço de cobrança associado ao pedido.
delivery_timestringTempo estimado para a entrega do pedido.
payment_method_idstringID do método de pagamento utilizado.
payment_methodstringNome do método de pagamento utilizado (ex: Cartão de Crédito, Boleto, etc.).
session_idstringID da sessão de compra do cliente.
totalnumberValor total do pedido, incluindo impostos, frete, descontos e outras taxas.
payment_dateDateData do pagamento do pedido.
access_codestringCódigo de acesso relacionado ao pedido.
shipment_integratorstringIdentificador do integrador de envio (transportadora ou serviço de entrega).
modifiedDateData e hora da última modificação do pedido.
printedbooleanIndica se a nota fiscal do pedido foi impressa.
interestnumberTaxa de juros aplicada sobre o pedido, caso tenha sido parcelado.
cart_additional_values_discountnumberDesconto adicional aplicado sobre o valor do carrinho de compras.
cart_additional_values_increasenumberAumento adicional aplicado sobre o valor do carrinho de compras.
id_quotationstringID da cotação associada ao pedido, caso aplicável.
estimated_delivery_dateDateData estimada para a entrega do pedido.
is_traceablebooleanIndica se o pedido é rastreável (true) ou não (false).
external_codestringCódigo externo relacionado ao pedido, se aplicável.
tracking_urlstringURL de rastreamento do pedido.
has_paymentbooleanIndica se o pedido foi pago (true) ou não (false).
has_shipmentbooleanIndica se o pedido foi enviado (true) ou não (false).
has_invoicebooleanIndica se o pedido foi faturado (true) ou não (false).
delivery_dateDateData da entrega do pedido.
total_comission_usernumberComissão total do usuário (se aplicável) sobre o pedido.
total_comissionnumberComissão total sobre o pedido.
costnumberCusto total do pedido para o vendedor ou a loja.
app_idstringID do aplicativo associado ao pedido, se aplicável.
store_segmentstringSegmento da loja ou categoria de produtos do pedido.
payment_method_typestringTipo do método de pagamento utilizado (ex: "Cartão", "Boleto", "Transferência Bancária").
couponnumberValor do cupom de desconto aplicado no pedido.
order_status_typestringTipo de status do pedido, como "Novo", "Processando", "Concluído", etc.
order_statusstringStatus atual do pedido.
order_status_idstringID único do status atual do pedido.
integration_idstringID da integração com o sistema de e-commerce.
project_idstringID do projeto associado ao pedido.
unit_idstringID da unidade de negócios associada ao pedido.
document_idstringID do documento relacionado ao pedido (ex: nota fiscal, recibo).
inserted_atDateData e hora em que o pedido foi inserido no sistema.

Exemplo de JSON com os Resultados Esperados#

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

🟢200Tray Orders
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/tray/orders' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "data": [
        {
            "status": "Em andamento",
            "id": "ORD123456",
            "date": "2025-01-01T10:00:00Z",
            "hour": "10:00",
            "customer_id": "CUST123",
            "partial_total": 120,
            "taxes": 18,
            "discount": 10,
            "point_sale": "POS001",
            "shipment": "Transportadora XYZ",
            "shipment_value": 20,
            "shipment_date": "2025-01-02T10:00:00Z",
            "delivered": false,
            "delivered_status": "Aguardando entrega",
            "shipping_cancelled": false,
            "store_note": "Embalagem frágil",
            "customer_note": "Enviar como presente",
            "partner_id": "PART123",
            "discount_coupon": "DISCOUNT10",
            "client_ip": "192.168.1.1",
            "payment_method_rate": 5,
            "installment": "1x",
            "value_1": 5,
            "sending_code": "SEND123456",
            "sending_date": "2025-01-02T10:00:00Z",
            "billing_address": "Rua Exemplo, 123",
            "delivery_time": "3 dias úteis",
            "payment_method_id": "PMT123",
            "payment_method": "pix",
            "session_id": "SESSION123",
            "total": 148,
            "payment_date": "2025-01-01T11:00:00Z",
            "access_code": "ACCESS123",
            "shipment_integrator": "Transportadora XYZ",
            "modified": "2025-01-01T12:00:00Z",
            "printed": true,
            "interest": 2,
            "cart_additional_values_discount": 5,
            "cart_additional_values_increase": 3,
            "id_quotation": "QUOT123",
            "estimated_delivery_date": "2025-01-05T10:00:00Z",
            "is_traceable": true,
            "external_code": "EXT123",
            "tracking_url": "https://tracking.com/123",
            "has_payment": true,
            "has_shipment": true,
            "has_invoice": true,
            "delivery_date": "2025-01-05T10:00:00Z",
            "total_comission_user": 5,
            "total_comission": 10,
            "cost": 100,
            "app_id": "APP123",
            "store_segment": "Eletrônicos",
            "payment_method_type": "Cartão",
            "coupon": 10,
            "order_status_type": "Novo",
            "order_status": "Em andamento",
            "order_status_id": "ORDSTAT123",
            "integration_id": "INTEGR123",
            "project_id": "PROJ123",
            "unit_id": "UNIT123",
            "document_id": "DOC123",
            "inserted_at": "2025-01-01T09:00:00Z"
        }
    ],
    "meta": {
        "page": 1,
        "limit": 500,
        "total": 1,
        "totalPages": 1,
        "hasNextPage": false,
        "hasPreviousPage": true
    }
}
Modificado em 2025-10-08 17:25:55
Página anterior
Tray Customers
Próxima página
Tray Products
Built with