Saltar para o conteúdo
ShopentlyLearn
Português (Portugal)

Obter — Pedidos

Consulte os dados de «Pedidos». O resultado depende dos parâmetros desta operação.

GET/api/v1/orders/{order_id}

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/example

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/example');
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/example', 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

JSON
{
  "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"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "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
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "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_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

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 guardada. 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 registado não cobra um cartão nem emite um reembolso por um provedor de pagamentos.

Escritas seguras

Permissões e planos

Encomenda · Totais

Os montantes e taxas vêm da encomenda guardada, incluindo correções das linhas. Dados históricos em falta são null e não são substituídos pelas taxas atuais do catálogo. Os montantes continuam a ser textos decimais.

A lista devolve resumos. Obtenha GET /api/v1/orders/{order_id} para cada resultado para exportar o detalhe financeiro completo. As repetições GET são limitadas e respeitam Retry-After. A exportação por data de criação não sincroniza correções posteriores.

  • tax_country_code · País fiscal · Dados guardados da encomenda · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Uma unidade · Antes dos descontos; lines[].original_total_* · Antes dos descontos; lines[].total_* · Após os descontos.
  • lines[].discount_* · Descontos; manual_discount · Desconto manual; percentage "10" = 10%.
  • delivery.net / tax / gross · Após os descontos; delivery.original_* · Antes dos descontos; delivery.discount_* · Descontos.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Desconhecido: null; zero conhecido: 0.
  • totals · Totais; tax_breakdown.groups · Grupos fiscais; Imposto não atribuído = order.tax − Σ groups.tax; ±.

payment.amount é o total da encomenda. O estado do pagamento não determina montantes pagos, reembolsados ou em dívida.

Parâmetros

Parâmetros do caminho

order_idTextoObrigatório

Identificador do pedido relacionado.

Restrições
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplo: "example"

Esta operação não aceita um corpo JSON.

Respostas

Resposta 200

Modelo completo: ApiResponse_OrderDetailData_

dataOrderDetailData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data

Modelo completo: OrderDetailData

created_atTextoObrigatório

Momento da criação.

format: "date-time"
customerCustomerData Obrigatório

Informações do cliente registadas para este recurso.

Campos · customer

Modelo completo: CustomerData

emailTextoObrigatório

Endereço de e-mail.

first_nameTexto nullObrigatório

Nome.

last_nameTexto nullObrigatório

Apelido.

phoneTexto nullObrigatório

Número de telefone.

deliveryShippingDetailData Obrigatório

Método de entrega e informações associadas.

Campos · delivery

Modelo completo: ShippingDetailData

amountMoneyData Obrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

datesDeliveryDatesData Obrigatório

Datas de envio e entrega

discount_grossMoneyData Obrigatório

Montante bruto · Descontos; Desconhecido: null; zero conhecido: 0.

discount_netMoneyData nullObrigatório

Montante líquido · Descontos; Desconhecido: null; zero conhecido: 0.

discount_taxMoneyData nullObrigatório

Montante do imposto · Descontos; Desconhecido: null; zero conhecido: 0.

discountsLista <OrderDeliveryDiscountData > nullObrigatório

Descontos

grossMoneyData Obrigatório

Montante bruto · Após os descontos; Desconhecido: null; zero conhecido: 0.

method_codeTexto nullObrigatório

Código do método de entrega ou pagamento.

method_nameTexto nullObrigatório

Nome do método de entrega ou pagamento.

netMoneyData nullObrigatório

Montante líquido · Após os descontos; Desconhecido: null; zero conhecido: 0.

original_grossMoneyData Obrigatório

Montante bruto · Envio · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

original_netMoneyData nullObrigatório

Montante líquido · Envio · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

original_taxMoneyData nullObrigatório

Montante do imposto · Envio · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

pickup_pointDeliveryPickupPointData nullObrigatório

Ponto de recolha

recipient_modeTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições
enum
["full_address", "pickup_contact"]
taxMoneyData nullObrigatório

Informações fiscais.

tax_category_idTexto nullObrigatório

Identificador da categoria fiscal.

tax_category_nameTexto nullObrigatório

Nome guardado da categoria fiscal; null.

tax_rateTexto nullObrigatório

tax_rate · Dados guardados da encomenda: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Campos · discount_amount

Modelo completo: MoneyData

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

currencyTextoObrigatório

Código da moeda do valor.

Restrições
pattern
"^[A-Z]{3}$"
minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4
discountsLista <OrderDiscountData > Obrigatório

Descontos

Campos · discounts

OrderDiscountData

Modelo completo: OrderDiscountData

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

invoiceInvoiceData nullObrigatório

Informações da fatura.

Campos · invoice

InvoiceData

Modelo completo: InvoiceData

null

invoice_requestedBooleanoObrigatório

Indica se foi solicitada uma fatura.

lifecycle_stateOrderLifecycleState Obrigatório

Estado do ciclo de vida do recurso.

linesLista <OrderLineData > Obrigatório

Dados das linhas do pedido preservados no momento do registo.

Campos · lines

OrderLineData

Modelo completo: OrderLineData

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

paymentPaymentData Obrigatório

Detalhes do pagamento registados no pedido.

Campos · payment

Modelo completo: PaymentData

amountMoneyData Obrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

environmentTextoObrigatório

Informações do ambiente associadas ao registo.

Restrições
enum
["live", "sandbox"]
method_codeTexto nullObrigatório

Código do método de entrega ou pagamento.

method_nameTexto nullObrigatório

Nome do método de entrega ou pagamento.

paid_atTexto nullObrigatório

Data e hora em que o pagamento foi marcado como pago.

Texto:format: "date-time"
statusOrderPaymentStatus Obrigatório

Estado aceito por esta operação específica.

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

pickup_pointPickupPointData nullObrigatório

Ponto de recolha

Campos · pickup_point

PickupPointData

Modelo completo: PickupPointData

null

prices_include_taxBooleanoObrigatório

Indica se os preços da lista incluem impostos.

shipping_addressAddressData nullObrigatório

Endereço de entrega.

Campos · shipping_address

AddressData

Modelo completo: AddressData

null

shipping_discount_amountMoneyData Obrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Campos · shipping_discount_amount

Modelo completo: MoneyData

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

currencyTextoObrigatório

Código da moeda do valor.

Restrições
pattern
"^[A-Z]{3}$"
minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4
statusOrderStatusData Obrigatório

Estado aceito por esta operação específica.

Campos · status

Modelo completo: OrderStatusData

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

nameTextoObrigatório

Nome do recurso no contexto correspondente.

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

subtotalMoneyData Obrigatório

Valor anterior aos componentes adicionais indicados na resposta.

Campos · subtotal

Modelo completo: MoneyData

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

currencyTextoObrigatório

Código da moeda do valor.

Restrições
pattern
"^[A-Z]{3}$"
minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4
taxMoneyData Obrigatório

Informações fiscais.

Campos · tax

Modelo completo: MoneyData

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

currencyTextoObrigatório

Código da moeda do valor.

Restrições
pattern
"^[A-Z]{3}$"
minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obrigatório

Grupos fiscais · source + tax_rate; unallocated_tax.

Campos · tax_breakdown

Modelo completo: OrderTaxBreakdownData

groupsLista <OrderTaxGroupData > Obrigatório

Grupos fiscais · source + tax_rate; Desconhecido: null; zero conhecido: 0.

unallocated_taxMoneyData Obrigatório

Imposto não atribuído = order.tax − Σ groups.tax; ±.

tax_country_codeTexto nullObrigatório

País fiscal · Dados guardados da encomenda · ISO 3166-1 alpha-2; null.

totalMoneyData Obrigatório

Valor total.

Campos · total

Modelo completo: MoneyData

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

currencyTextoObrigatório

Código da moeda do valor.

Restrições
pattern
"^[A-Z]{3}$"
minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4
totalsOrderTotalsData Obrigatório

Totais · net / tax / gross; Antes dos descontos / Após os descontos.

Campos · totals

Modelo completo: OrderTotalsData

before_discountsOrderAmountBreakdownData Obrigatório

Encomenda · Antes dos descontos · net / tax / gross.

discountsOrderAmountBreakdownData Obrigatório

Descontos

orderOrderAmountBreakdownData Obrigatório

Encomenda · Após os descontos · net / tax / gross.

product_discountsOrderAmountBreakdownData Obrigatório

Produtos · Descontos · net / tax / gross.

productsOrderAmountBreakdownData Obrigatório

Produtos · Após os descontos · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obrigatório

Produtos · Antes dos descontos · net / tax / gross.

shippingOrderAmountBreakdownData Obrigatório

Envio · Após os descontos · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obrigatório

Envio · Antes dos descontos · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obrigatório

Envio · Descontos · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Campos · meta

ContextPageMeta

Modelo completo: ContextPageMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

ContextMeta

Modelo completo: ContextMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

PageMeta

Modelo completo: PageMeta

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

RequestMeta

Modelo completo: RequestMeta

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Pedido inválido
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 pedidos excedido
Outros estados HTTP (7)
405
Método não permitido
413
Pedido demasiado 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-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0

Catálogo de erros · Saber mais