Vtex Orders
GET
https://rest.api.mktlab.app/v1/vtex/orders
Respota
| Campo | Tipo | Descrição |
|---|---|---|
id_insert | number | ID do registro inserido no banco de dados. |
order_id | string | ID único do pedido na plataforma. |
sequence | string | Sequência do pedido, caso seja parte de um grupo de pedidos. |
seller_order_id | string | ID do pedido atribuído pelo vendedor, podendo ser utilizado para identificar pedidos específicos. |
origin | string | Origem do pedido (ex: online, físico). |
affiliate_id | string | ID do afiliado responsável pela venda, se aplicável. |
sales_channel | string | Canal de vendas utilizado para realizar o pedido (ex: e-commerce, marketplace). |
merchant_name | string | Nome do comerciante ou loja responsável pelo pedido. |
status | string | Status atual do pedido (ex: pendente, finalizado, cancelado). |
status_description | string | Descrição detalhada do status do pedido. |
value | number | Valor total do pedido. |
creation_date | Date | Data de criação do pedido, indicando quando o pedido foi registrado. |
last_change | Date | Data da última alteração no pedido (ex: mudança de status ou atualização de dados). |
order_group | string | Grupo de pedidos, se o pedido pertencer a um grupo específico de compras. |
follow_up_email | string | E-mail de acompanhamento relacionado ao pedido, utilizado para comunicação. |
last_message | string | Última mensagem ou nota relacionada ao pedido. |
is_completed | boolean | Indica se o pedido foi concluído (verdadeiro) ou ainda está em andamento (falso). |
order_form_id | string | ID do formulário do pedido associado à plataforma de e-commerce. |
authorized_date | Date | Data em que o pedido foi autorizado para pagamento ou processamento. |
invoiced_date | Date | Data em que a fatura do pedido foi gerada. |
cancel_reason | string | Motivo do cancelamento do pedido, se aplicável. |
integration_id | string | ID da integração da plataforma com a conta do sistema Vtex. |
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, utilizado para fins de rastreamento ou contabilidade. |
inserted_at | Date | Data e hora em que o registro foi inserido no sistema (formato ISO 8601). |
Requisição
Parâmetros de Consulta
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/vtex/orders' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"id_insert": 1,
"order_id": "ORD123456",
"sequence": "SEQ123",
"seller_order_id": "SELL123",
"origin": "online",
"affiliate_id": "AFF123",
"sales_channel": "ecommerce",
"merchant_name": "Loja Exemplo",
"status": "finalizado",
"status_description": "Pedido concluído com sucesso",
"value": 299.99,
"creation_date": "2025-01-01T10:00:00Z",
"last_change": "2025-01-02T15:30:00Z",
"order_group": "GROUP001",
"follow_up_email": "cliente@exemplo.com",
"last_message": "Seu pedido está em andamento.",
"is_completed": true,
"order_form_id": "FORM123",
"authorized_date": "2025-01-01T12:00:00Z",
"invoiced_date": "2025-01-01T14:00:00Z",
"cancel_reason": "",
"integration_id": "INT123",
"project_id": "PROJ001",
"unit_id": "UNIT001",
"document_id": "DOC001",
"inserted_at": "2025-01-01T16:00:00Z"
}
],
"meta": {
"page": 1,
"limit": 500,
"total": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": true
}
}Modificado em 2025-10-08 17:25:55