Listar — Pedidos
Consulte os dados de “Pedidos”. O resultado depende dos parâmetros desta operação.
GET/api/v1/orders
- Autenticação
Bearer- Disponível a partir de
- BASIC
- Permissões necessárias
orders.order:read
Exemplos de código
Exemplo de requisição
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/orders?limit=20'
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders?limit=20');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'GET', base_url + '/api/v1/orders?limit=20', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Exemplo de resposta 200
{
"data": [
{
"created_at": "2026-10-19T10:00:00Z",
"customer": {
"email": "customer@example.invalid",
"first_name": "Example",
"last_name": "Example",
"phone": null
},
"delivery": {
"amount": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2
},
"dates": {
"dispatch_timezone": "Europe/Warsaw",
"estimated_delivery_from": "2026-10-20",
"estimated_delivery_to": "2026-10-21",
"planned_dispatch_on": "2026-10-19"
},
"method_code": "shipping-old",
"method_name": "Historic carrier",
"pickup_point": null,
"recipient_mode": "full_address"
},
"discount_amount": {
"amount": "24.60",
"currency": "PLN",
"minor_units": 2
},
"id": "order-0000",
"lifecycle_state": "placed",
"locale": "pl",
"market_id": "market-pl",
"number": "0001",
"payment": {
"amount": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
},
"environment": "live",
"method_code": "payment-old",
"method_name": "Historic method",
"paid_at": null,
"status": "unpaid",
"updated_at": "2026-10-19T10:00:00Z",
"version": 0
},
"prices_include_tax": true,
"shipping_discount_amount": {
"amount": "24.60",
"currency": "PLN",
"minor_units": 2
},
"status": {
"id": "status-0",
"name": "Status 0",
"updated_at": "2026-10-19T10:00:00Z",
"version": 1
},
"subtotal": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
},
"tax": {
"amount": "49.40",
"currency": "PLN",
"minor_units": 2
},
"tax_country_code": "PL",
"total": {
"amount": "329.40",
"currency": "PLN",
"minor_units": 2
}
}
],
"meta": {
"pagination": {
"has_more": false,
"limit": 20,
"next_cursor": null
},
"request_id": "example"
}
}
Como funciona
- A coleção oferece resumos de pedidos e filtros por número, estado, estado do pagamento e momento de criação.
- A lista e os detalhes dos pedidos incluem delivery.dates. As datas YYYY-MM-DD são previstas e não confirmam o envio. As datas atuais têm prioridade; pedidos antigos usam a estimativa salva. Valores apagados ou desconhecidos são null. Os detalhes incluem também todas as linhas e imagens dos produtos.
- Obtenha identificadores de estado válidos em /api/v1/order-statuses.
- O estado do pedido e o estado do pagamento usam endpoints PATCH e permissões separados.
- Alterar o estado de pagamento registrado não cobra um cartão nem emite um reembolso por um provedor de pagamentos.
Pedido · Totais
Os valores e alíquotas vêm do pedido salvo, incluindo correções dos itens. Dados históricos ausentes são null e não são substituídos pelas alíquotas atuais do catálogo. Os valores continuam sendo textos decimais.
A lista retorna resumos. Obtenha GET /api/v1/orders/{order_id} para cada resultado para exportar o detalhamento financeiro completo. As tentativas GET são limitadas e respeitam Retry-After. A exportação por data de criação não sincroniza correções posteriores.
Parâmetros
Parâmetros de consulta
limitNúmero inteiroOpcionalNúmero máximo de registros nesta página.
minimum:1maximum:100cursorTexto nullOpcionalValor opaco de continuação retornado pela página anterior.
Texto:minLength:1maxLength:1024numberTexto nullOpcionalNúmero do pedido ou da solicitação exibido ao usuário.
Texto:minLength:1maxLength:48status_idTexto nullOpcionalIdentificador obtido do catálogo de estados correspondente.
Restrições · Texto 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusTexto nullOpcionalEstado de pagamento registrado.
Restrições · Texto 1
enum["unpaid", "paid", "failed", "refunded"]
created_fromTexto nullOpcionalInício do filtro por momento de criação.
Texto:format:"date-time"created_toTexto nullOpcionalFim do filtro por momento de criação.
Texto:format:"date-time"
Esta operação não aceita um corpo JSON.
Respostas
Resposta 200
Modelo completo: ApiResponse_list_OrderSummaryData__
dataLista <OrderSummaryData> ObrigatórioConteúdo de uma resposta bem-sucedida.
Campos ·
dataModelo completo:
OrderSummaryDatacreated_atTextoObrigatórioMomento da criação.
format:"date-time"customerCustomerDataObrigatórioInformações do cliente registradas para este recurso.
deliveryShippingDataObrigatórioMétodo de entrega e informações associadas.
discount_amountMoneyDataObrigatórioValor decimal codificado como texto JSON; null apenas quando permitido.
idTextoObrigatórioIdentificador do recurso; preserve-o conforme retornado.
lifecycle_stateOrderLifecycleStateObrigatórioEstado do ciclo de vida do recurso.
localeTextoObrigatórioIdioma selecionado para esta requisição.
market_idTextoObrigatórioIdentificador do mercado retornado pelo endpoint de contexto.
numberTextoObrigatórioNúmero do pedido ou da solicitação exibido ao usuário.
paymentPaymentDataObrigatórioDetalhes do pagamento registrados no pedido.
prices_include_taxBooleanoObrigatórioIndica se os preços da lista incluem impostos.
shipping_discount_amountMoneyDataObrigatórioValor decimal codificado como texto JSON; null apenas quando permitido.
statusOrderStatusDataObrigatórioEstado aceito por esta operação específica.
subtotalMoneyDataObrigatórioValor anterior aos componentes adicionais indicados na resposta.
taxMoneyDataObrigatórioInformações fiscais.
tax_country_codeTexto nullObrigatórioPaís fiscal · Dados salvos do pedido · ISO 3166-1 alpha-2; null.
totalMoneyDataObrigatórioValor total.
metaContextPageMetaContextMetaPageMetaRequestMetaObrigatórioMetadados da resposta.
Campos ·
metaModelo completo:
ContextPageMetalocaleTextoObrigatórioIdioma selecionado para esta requisição.
market_codeTextoObrigatórioCódigo do mercado retornado pelo endpoint de contexto.
market_idTextoObrigatórioIdentificador do mercado retornado pelo endpoint de contexto.
paginationPaginationObrigatórioMetadados da paginação por cursor.
request_idTextoObrigatórioIdentificador da solicitação; nos metadados da resposta identifica a requisição HTTP.
minLength:1maxLength:100
localeTextoObrigatórioIdioma selecionado para esta requisição.
market_codeTextoObrigatórioCódigo do mercado retornado pelo endpoint de contexto.
market_idTextoObrigatórioIdentificador do mercado retornado pelo endpoint de contexto.
request_idTextoObrigatórioIdentificador da solicitação; nos metadados da resposta identifica a requisição HTTP.
minLength:1maxLength:100
paginationPaginationObrigatórioMetadados da paginação por cursor.
request_idTextoObrigatórioIdentificador da solicitação; nos metadados da resposta identifica a requisição HTTP.
minLength:1maxLength:100
request_idTextoObrigatórioIdentificador da solicitação; nos metadados da resposta identifica a requisição HTTP.
minLength:1maxLength:100
Estado HTTP
200- Resposta bem-sucedida Esquema
400- Requisição inválida
401- Autenticação necessária
403- Permissão negada
404- Recurso não encontrado
409- Conflito de versão
422- Falha na validação
429- Limite de requisições excedido
Outros status HTTP (7)
405- Método não permitido
413- Requisição muito grande
415- Formato não suportado
500- Erro do servidor
502- Erro do gateway da API
503- Serviço indisponível
504- Tempo de espera excedido
Catálogo de erros: ErrorResponse
Cabeçalhos
401
WWW-AuthenticateTextoOpcionalEsquema de autenticação exigido pelo servidor.
405
AllowTextoOpcionalMétodos HTTP aceitos por este recurso.
429, 503
Retry-AfterNúmero inteiroOpcionalEspera mínima antes de tentar novamente, em segundos.
minimum:0