Detalhe do Pedido
Retorna os dados completos de um pedido, incluindo produtos, cliente e pagamento.
GET /sellers/orders/{uuid}/
Headers
| Header | Valor | Obrigatório |
|---|---|---|
Authorization | Bearer mk_<env>_<token> | Sim |
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
uuid | string (UUID) | Sim | UUID do pedido |
Exemplo de Requisição
- cURL
- Python
- Node.js
curl -X GET https://api.somosmarcha.com/api/v1/sellers/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
-H "Authorization: Bearer $API_KEY"
import os
import requests
BASE_URL = "https://api.somosmarcha.com/api/v1"
ORDER_UUID = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
headers = {
"Authorization": f"Bearer {os.environ['API_KEY']}",
}
response = requests.get(f"{BASE_URL}/sellers/orders/{ORDER_UUID}/", headers=headers)
print(response.json())
const BASE_URL = "https://api.somosmarcha.com/api/v1";
const ORDER_UUID = "a1b2c3d4-e5f6-7890-abcd-ef1234567890";
const response = await fetch(`${BASE_URL}/sellers/orders/${ORDER_UUID}/`, {
headers: {
"Authorization": `Bearer ${process.env.API_KEY}`,
},
});
const data = await response.json();
console.log(data);
Resposta de Sucesso
Status: 200 OK
{
"message": "Sucesso!",
"data": {
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"items": [
{
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Plano Premium",
"images": [],
"price": 15000,
"quantity": 1,
"line_total_amount": 15000,
"commission_unit_amount": 1500,
"commission_total_amount": 1500,
"tracking_code": null,
"shipping_status": null
}
],
"customer": {
"name": "Maria da Silva",
"tax_id": "12345678901",
"tax_id_type": "CPF",
"email": "[email protected]",
"phone": "11999998888",
"address": "Rua Exemplo, 123"
},
"payment": {
"subtotal_amount": 15000,
"shipping_amount": 0,
"discount_amount": 0,
"commission_amount": 1500,
"gross_amount": 15000,
"fee_amount": 149,
"net_amount": 14851,
"method": "PIX",
"status": "PAID"
},
"parties": {
"producer": { "name": "Joao Silva" },
"seller": { "name": "Carlos Vendedor" },
"affiliate": { "name": "Ana Lima" }
},
"timestamps": {
"created_at": "2026-01-15T10:00:00Z",
"paid_at": "2026-01-15T10:05:00Z"
},
"delivery": {
"estimated_delivery_date": null,
"delivered_at": null,
"signed_by": null
}
}
}
Campos da Resposta
items[]
Notação financeira
Todo campo que termina em _amount é um inteiro, em centavos. Exemplo: 15000 = R$ 150,00.
| Campo | Tipo | Descrição |
|---|---|---|
uuid | string | null | UUID do produto |
name | string | null | Nome do produto |
images | string[] | URLs das imagens do produto |
price | integer | Preço unitário em centavos |
quantity | integer | Quantidade comprada |
line_total_amount | integer | Valor total da linha do item (preço unitário × quantidade) em centavos |
commission_unit_amount | integer | Comissão por unidade em centavos |
commission_total_amount | integer | Comissão total em centavos |
tracking_code | string | null | Código de rastreio |
shipping_status | string | null | Status de envio: AWAITING_SHIPMENT, SHIPPED, DELIVERED, RETURNED, LOST |
customer
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Nome do cliente |
tax_id | string | CPF (11 dígitos) ou CNPJ (14 dígitos) |
tax_id_type | string | "CPF" ou "CNPJ" |
email | string | Email do cliente |
phone | string | Telefone do cliente |
address | string | null | Endereço completo |
payment
| Campo | Tipo | Descrição |
|---|---|---|
subtotal_amount | integer | Subtotal em centavos |
shipping_amount | integer | Frete em centavos |
discount_amount | integer | Desconto em centavos |
commission_amount | integer | Comissão total em centavos |
gross_amount | integer | Valor bruto cobrado do cliente em centavos |
fee_amount | integer | Taxa da plataforma em centavos |
net_amount | integer | Valor líquido recebido (gross_amount - fee_amount) em centavos |
method | string | null | Método: PIX, CARD, BOLETO |
status | string | Status: PROCESSING, PENDING, PAID, REFUSED, REFUNDED, CANCELED, EXPIRED, MED, CHARGEBACK |
parties
Participantes do pedido. Sub-objetos são omitidos quando não há dados (por exemplo, sem afiliado, parties.affiliate não aparece).
| Campo | Tipo | Descrição |
|---|---|---|
parties.producer.name | string | Nome do dono/produtor do produto |
parties.seller.name | string | Nome do vendedor responsável pelo pedido |
parties.affiliate.name | string | Nome do afiliado, quando a venda passou por um link de afiliação |
informação
Identificadores internos (id) não são expostos — apenas o nome de cada participante.
timestamps
| Campo | Tipo | Descrição |
|---|---|---|
created_at | datetime | Data/hora de criação |
paid_at | datetime | null | Data/hora do pagamento |
delivery
| Campo | Tipo | Descrição |
|---|---|---|
estimated_delivery_date | date | null | Data estimada de entrega |
delivered_at | datetime | null | Data/hora efetiva de entrega |
signed_by | string | null | Nome de quem assinou na entrega |
Envio (
tracking_code/shipping_status) vs entrega (delivery)O rastreio (tracking_code e shipping_status) fica em cada item, dentro de items[], e descreve a remessa em trânsito. O bloco delivery no nível do pedido registra o resultado final da entrega: data estimada, data efetiva e quem assinou. Para entender a relação entre todos os termos de envio, veja o Glossário de envio e entrega.
Respostas de Erro
Status: 404 Not Found
{
"message": "Pedido não encontrado."
}