Pular para o conteúdo principal

Detalhe do Pedido

Retorna os dados completos de um pedido, incluindo produtos, cliente e pagamento.

GET /sellers/orders/{uuid}/

Headers

HeaderValorObrigatório
AuthorizationBearer mk_<env>_<token>Sim

Parâmetros de Path

ParâmetroTipoObrigatórioDescrição
uuidstring (UUID)SimUUID do pedido

Exemplo de Requisição

curl -X GET https://api.somosmarcha.com/api/v1/sellers/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
-H "Authorization: Bearer $API_KEY"

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.

CampoTipoDescrição
uuidstring | nullUUID do produto
namestring | nullNome do produto
imagesstring[]URLs das imagens do produto
priceintegerPreço unitário em centavos
quantityintegerQuantidade comprada
line_total_amountintegerValor total da linha do item (preço unitário × quantidade) em centavos
commission_unit_amountintegerComissão por unidade em centavos
commission_total_amountintegerComissão total em centavos
tracking_codestring | nullCódigo de rastreio
shipping_statusstring | nullStatus de envio: AWAITING_SHIPMENT, SHIPPED, DELIVERED, RETURNED, LOST

customer

CampoTipoDescrição
namestringNome do cliente
tax_idstringCPF (11 dígitos) ou CNPJ (14 dígitos)
tax_id_typestring"CPF" ou "CNPJ"
emailstringEmail do cliente
phonestringTelefone do cliente
addressstring | nullEndereço completo

payment

CampoTipoDescrição
subtotal_amountintegerSubtotal em centavos
shipping_amountintegerFrete em centavos
discount_amountintegerDesconto em centavos
commission_amountintegerComissão total em centavos
gross_amountintegerValor bruto cobrado do cliente em centavos
fee_amountintegerTaxa da plataforma em centavos
net_amountintegerValor líquido recebido (gross_amount - fee_amount) em centavos
methodstring | nullMétodo: PIX, CARD, BOLETO
statusstringStatus: 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).

CampoTipoDescrição
parties.producer.namestringNome do dono/produtor do produto
parties.seller.namestringNome do vendedor responsável pelo pedido
parties.affiliate.namestringNome 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

CampoTipoDescrição
created_atdatetimeData/hora de criação
paid_atdatetime | nullData/hora do pagamento

delivery

CampoTipoDescrição
estimated_delivery_datedate | nullData estimada de entrega
delivered_atdatetime | nullData/hora efetiva de entrega
signed_bystring | nullNome 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."
}