| Campo | Tipo | Descrição |
|---|---|---|
status | string | Status do pedido, como "Em andamento", "Cancelado", "Concluído". |
id | string | ID único do pedido. |
date | Date | Data de criação do pedido. |
hour | string | Hora em que o pedido foi criado. |
customer_id | string | ID único do cliente associado ao pedido. |
partial_total | number | Total parcial do pedido, antes de impostos e descontos. |
taxes | number | Valor total dos impostos aplicados ao pedido. |
discount | number | Valor total do desconto aplicado ao pedido. |
point_sale | string | Ponto de venda ou identificador da loja onde o pedido foi realizado. |
shipment | string | Método de envio escolhido para o pedido. |
shipment_value | number | Valor do frete ou envio do pedido. |
shipment_date | Date | Data de envio do pedido. |
delivered | boolean | Indica se o pedido foi entregue (true) ou não (false). |
delivered_status | string | Status da entrega do pedido (ex: "Entregue", "Em trânsito", "Aguardando entrega"). |
shipping_cancelled | boolean | Indica se o envio foi cancelado. |
store_note | string | Observações da loja sobre o pedido. |
customer_note | string | Observações do cliente sobre o pedido. |
partner_id | string | ID do parceiro responsável pelo pedido (se aplicável). |
discount_coupon | string | Código do cupom de desconto utilizado no pedido (se aplicável). |
client_ip | string | IP do cliente no momento da realização do pedido. |
payment_method_rate | number | Taxa do método de pagamento utilizado para o pedido. |
installment | string | Número de parcelas do pagamento, se for parcelado. |
value_1 | number | Valor adicional ou relacionado a uma categoria do pedido. |
sending_code | string | Código de envio gerado para o pedido. |
sending_date | Date | Data em que o pedido foi enviado. |
billing_address | string | Endereço de cobrança associado ao pedido. |
delivery_time | string | Tempo estimado para a entrega do pedido. |
payment_method_id | string | ID do método de pagamento utilizado. |
payment_method | string | Nome do método de pagamento utilizado (ex: Cartão de Crédito, Boleto, etc.). |
session_id | string | ID da sessão de compra do cliente. |
total | number | Valor total do pedido, incluindo impostos, frete, descontos e outras taxas. |
payment_date | Date | Data do pagamento do pedido. |
access_code | string | Código de acesso relacionado ao pedido. |
shipment_integrator | string | Identificador do integrador de envio (transportadora ou serviço de entrega). |
modified | Date | Data e hora da última modificação do pedido. |
printed | boolean | Indica se a nota fiscal do pedido foi impressa. |
interest | number | Taxa de juros aplicada sobre o pedido, caso tenha sido parcelado. |
cart_additional_values_discount | number | Desconto adicional aplicado sobre o valor do carrinho de compras. |
cart_additional_values_increase | number | Aumento adicional aplicado sobre o valor do carrinho de compras. |
id_quotation | string | ID da cotação associada ao pedido, caso aplicável. |
estimated_delivery_date | Date | Data estimada para a entrega do pedido. |
is_traceable | boolean | Indica se o pedido é rastreável (true) ou não (false). |
external_code | string | Código externo relacionado ao pedido, se aplicável. |
tracking_url | string | URL de rastreamento do pedido. |
has_payment | boolean | Indica se o pedido foi pago (true) ou não (false). |
has_shipment | boolean | Indica se o pedido foi enviado (true) ou não (false). |
has_invoice | boolean | Indica se o pedido foi faturado (true) ou não (false). |
delivery_date | Date | Data da entrega do pedido. |
total_comission_user | number | Comissão total do usuário (se aplicável) sobre o pedido. |
total_comission | number | Comissão total sobre o pedido. |
cost | number | Custo total do pedido para o vendedor ou a loja. |
app_id | string | ID do aplicativo associado ao pedido, se aplicável. |
store_segment | string | Segmento da loja ou categoria de produtos do pedido. |
payment_method_type | string | Tipo do método de pagamento utilizado (ex: "Cartão", "Boleto", "Transferência Bancária"). |
coupon | number | Valor do cupom de desconto aplicado no pedido. |
order_status_type | string | Tipo de status do pedido, como "Novo", "Processando", "Concluído", etc. |
order_status | string | Status atual do pedido. |
order_status_id | string | ID único do status atual do pedido. |
integration_id | string | ID da integração com o sistema de e-commerce. |
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 (ex: nota fiscal, recibo). |
inserted_at | Date | Data e hora em que o pedido foi inserido no sistema. |
curl --location --request GET 'https://rest.api.mktlab.app/v1/tray/orders' \
--header 'Authorization: Bearer <token>'{
"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
}
}