Esquemas de dados: Pedidos

Esquemas de dados: Pedidos. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Endereço de entrega

AddressData · Esquema · Esquemas de dados: Pedidos

address_line_1Texto nullObrigatório: Primeira linha de endereço.
address_line_2Texto nullObrigatório: Informações adicionais do endereço.
cityTexto nullObrigatório: Cidade ou localidade.
country_codeTexto nullObrigatório: Código do país.
first_nameTexto nullObrigatório: Nome.
house_numberTexto nullObrigatório: Número do edifício ou da casa.
last_nameTexto nullObrigatório: Apelido.
phoneTexto nullObrigatório: Número de telefone.
postal_codeTexto nullObrigatório: Código postal.
regionTexto nullObrigatório: Região administrativa.
streetTexto nullObrigatório: Nome da rua.

Campos adicionais: Não

Listar — Pedidos — Resposta

ApiResponse_list_OrderSummaryData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <OrderSummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_OrderSummaryData__.

Exemplo: [{"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}}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Obter — Pedidos — Resposta

ApiResponse_OrderDetailData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataOrderDetailData Obrigatório: Exemplo de resposta · OrderDetailData.

Exemplo: {"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}}}}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"request_id":"example-request"}

Campos adicionais: Não

Informações do cliente registadas para este recurso

CustomerData · Esquema · Esquemas de dados: Pedidos

emailTextoObrigatório: Endereço de e-mail.

Exemplo: "customer@example.invalid"
first_nameTexto nullObrigatório: Nome.

Exemplo: "Example"
last_nameTexto nullObrigatório: Apelido.

Exemplo: "Example"
phoneTexto nullObrigatório: Número de telefone.

Exemplo: null

Campos adicionais: Não

Datas de envio e entrega

DeliveryDatesData · 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.

dispatch_timezoneTexto nullObrigatório: Fuso horário do envio (IANA; null).

Exemplo: "Europe/Warsaw"
estimated_delivery_fromTexto nullObrigatório: Início da entrega estimada (YYYY-MM-DD; null).

Texto:format: "date"

Exemplo: "2026-10-20"
estimated_delivery_toTexto nullObrigatório: Fim da entrega estimada (YYYY-MM-DD; null).

Texto:format: "date"

Exemplo: "2026-10-21"
planned_dispatch_onTexto nullObrigatório: Data de envio prevista (YYYY-MM-DD; null).

Texto:format: "date"

Exemplo: "2026-10-19"

Campos adicionais: Não

DeliveryPickupPointData

DeliveryPickupPointData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

addressPickupPointAddressData Obrigatório

Endereço de entrega.

codeTextoObrigatório

Código estável legível por programas.

Restrições

pattern: "^[A-Za-z0-9_-]{1,63}$"

coordinatesPickupPointCoordinatesData nullObrigatório

Valor definido pelo esquema que o contém.

country_codeTextoObrigatório

Código do país.

Restrições

pattern: "^[A-Z]{2}$"

environmentTextoObrigatório

Informações do ambiente associadas ao registo.

Restrições

enum: ["live", "sandbox"]

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["locker", "pickup_point"]

location_descriptionTexto nullObrigatório

Descrição no idioma selecionado.

Texto:maxLength: 1000

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160

opening_hoursTexto nullObrigatório

Opening hours

Texto:maxLength: 500

operatorTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 63

verified_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Campos adicionais: Não

Informações da fatura

InvoiceData · Esquema · Esquemas de dados: Pedidos

address_line_1Texto nullObrigatório: Primeira linha de endereço.
address_line_2Texto nullObrigatório: Informações adicionais do endereço.
cityTexto nullObrigatório: Cidade ou localidade.
company_nameTexto nullObrigatório: Nome da empresa.
country_codeTexto nullObrigatório: Código do país.
house_numberTexto nullObrigatório: Número do edifício ou da casa.
postal_codeTexto nullObrigatório: Código postal.
regionTexto nullObrigatório: Região administrativa.
streetTexto nullObrigatório: Nome da rua.
tax_identifierTexto nullObrigatório: Número de identificação fiscal.
tax_schemeTexto nullObrigatório: Esquema de cálculo de impostos.

Campos adicionais: Não

Montante líquido / Montante do imposto / Montante bruto

OrderAmountBreakdownData · 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.

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

Exemplo: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObrigatório: Montante líquido · Após os descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObrigatório: Montante do imposto · Após os descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"58.60","currency":"PLN","minor_units":2}

Campos adicionais: Não

Envio · Descontos

OrderDeliveryDiscountData · 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.

amountMoneyData Obrigatório

Montante bruto · Envio · Descontos.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}

campaign_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "saved-coupon"

codeTexto nullObrigatório

Código estável legível por programas.

Exemplo: "SAVE"

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["coupon", "promotion"]

Exemplo: "coupon"

nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Saved coupon"

sequenceNúmero inteiro nullObrigatório

Posição na coleção ordenada.

Exemplo: 1

versionNúmero inteiroObrigatório

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

Exemplo: 3

Campos adicionais: Não

Obter — Pedidos — Resposta

OrderDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-10-19T10:00:00Z"
customerCustomerData Obrigatório: Informações do cliente registadas para este recurso.

Exemplo: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obrigatório: Método de entrega e informações associadas.

Exemplo: {"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_amountMoneyData Obrigatório: Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsLista <OrderDiscountData > Obrigatório: Descontos

Exemplo: [{"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}]
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (OrderDetailData).

Exemplo: "order-0000"
invoiceInvoiceData nullObrigatório: Informações da fatura.

Exemplo: null
invoice_requestedBooleanoObrigatório: Indica se foi solicitada uma fatura.

Exemplo: false
lifecycle_stateOrderLifecycleState Obrigatório: Estado do ciclo de vida do recurso.

Exemplo: "placed"
linesLista <OrderLineData > Obrigatório: Dados das linhas do pedido preservados no momento do registo.

Exemplo: [{"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":[]}]
localeTextoObrigatório: Idioma selecionado para esta requisição.

Exemplo: "pl"
market_idTextoObrigatório: Identificador do mercado retornado pelo endpoint de contexto.

Exemplo: "market-pl"
numberTextoObrigatório: Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "0001"
paymentPaymentData Obrigatório: Detalhes do pagamento registados no pedido.

Exemplo: {"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_pointPickupPointData nullObrigatório: Ponto de recolha

Exemplo: null
prices_include_taxBooleanoObrigatório: Indica se os preços da lista incluem impostos.

Exemplo: true
shipping_addressAddressData nullObrigatório: Endereço de entrega.

Exemplo: null
shipping_discount_amountMoneyData Obrigatório: Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obrigatório: Estado aceito por esta operação específica.

Exemplo: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obrigatório: Valor anterior aos componentes adicionais indicados na resposta.

Exemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obrigatório: Informações fiscais.

Exemplo: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obrigatório: Grupos fiscais · source + tax_rate; unallocated_tax.

Exemplo: {"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_codeTexto nullObrigatório: País fiscal · Dados guardados da encomenda · ISO 3166-1 alpha-2; null.

Exemplo: "PL"
totalMoneyData Obrigatório: Valor total.

Exemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obrigatório: Totais · net / tax / gross; Antes dos descontos / Após os descontos.

Exemplo: {"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}}}

Campos adicionais: Não

Metadados e URL da imagem

OrderImageData · Esquema · Esquemas de dados: Pedidos

altTexto nullObrigatório: Texto alternativo de uma imagem.
sourceTextoOpcional: Origem da atividade registada.

const: "current_catalog"

Predefinido: "current_catalog"
urlTextoObrigatório: URL do recurso.

Campos adicionais: Não

Estado do ciclo de vida do recurso

OrderLifecycleState · Esquema · Esquemas de dados: Pedidos

Texto

Restrições

enum: ["placed", "cancelled", "fulfilled", "returned"]

Campos adicionais: Sim

Dados das linhas do pedido preservados no momento do registo

OrderLineData · Esquema · Esquemas de dados: Pedidos

discount_amountMoneyData Obrigatório: Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obrigatório: Montante bruto · Descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObrigatório: Montante líquido · Descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObrigatório: Montante do imposto · Descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsLista <OrderDiscountData > Obrigatório: Descontos · net / tax / gross.

Exemplo: [{"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}]
identifiersObjetoCampos adicionais: TextoObrigatório: Códigos de identificação do produto.

Exemplo: {}
imageOrderImageData nullObrigatório: Metadados e URL da imagem.

Exemplo: null
line_idTextoObrigatório: Identificador estável da linha da encomenda.

Exemplo: "saved-line-a"
manual_discountOrderManualDiscountData nullObrigatório: Desconto manual; null.

Exemplo: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Saved A"
original_totalMoneyData Obrigatório: Valor total.

Exemplo: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obrigatório: Montante bruto · Produtos · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObrigatório: Montante líquido · Produtos · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObrigatório: Montante do imposto · Produtos · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"46.00","currency":"PLN","minor_units":2}
positionNúmero inteiroObrigatório: Posição na coleção ordenada.

Exemplo: 1
product_idTextoObrigatório: Identificador do produto.

Exemplo: "product-api"
quantityNúmero inteiroObrigatório: Número de unidades.

Exemplo: 2
skuTextoObrigatório: Código da unidade de manutenção de stock.

Exemplo: "A"
taxMoneyData nullObrigatório: Montante do imposto · Uma unidade · Dados guardados da encomenda; tax ≠ unit_tax; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idTexto nullObrigatório: Identificador da categoria fiscal · Dados guardados da encomenda; null.

Exemplo: "standard"
tax_category_nameTexto nullObrigatório: Nome guardado da categoria fiscal; null.

Exemplo: "VAT 23%"
tax_rateTexto nullObrigatório: tax_rate · Dados guardados da encomenda: "0.23" = 23%; "0" ≠ null.

Exemplo: "0.23"
totalMoneyData Obrigatório: Valor total.

Exemplo: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obrigatório: Montante bruto · Produtos · Após os descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObrigatório: Montante líquido · Produtos · Após os descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObrigatório: Montante do imposto · Produtos · Após os descontos · Dados guardados da encomenda; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obrigatório: Montante bruto · Uma unidade · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObrigatório: Montante líquido · Uma unidade · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obrigatório: Preço por unidade.

Exemplo: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObrigatório: Montante do imposto · Uma unidade · Antes dos descontos; Desconhecido: null; zero conhecido: 0.

Exemplo: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idTexto nullObrigatório: Identificador da variante do produto.

Exemplo: null
variant_optionsLista <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obrigatório: Opções de variante associadas ao produto ou aos dados preservados.

Exemplo: []

Campos adicionais: Não

Desconto manual

OrderManualDiscountData · 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.

amountMoneyData Obrigatório

Montante bruto · Desconto manual · Dados guardados da encomenda.

Exemplo: {"amount":"12.30","currency":"PLN","minor_units":2}

kindTextoObrigatório

Tipo de desconto: percentage / fixed.

Restrições

enum: ["percentage", "fixed"]

Exemplo: "fixed"

valueTextoObrigatório

Valor configurado: percentage "10" = 10%; fixed = Montante bruto.

Exemplo: "12.30"

Campos adicionais: Não

Estado aceito por esta operação específica

OrderPaymentStatus · Esquema · Esquemas de dados: Pedidos

Texto

Restrições

enum: ["unpaid", "paid", "failed", "refunded"]

Campos adicionais: Sim

Estado aceito por esta operação específica

OrderStatusData · Esquema · Esquemas de dados: Pedidos

idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (OrderStatusData).

Exemplo: "status-0"
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Status 0"
updated_atTextoObrigatório: Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-10-19T10:00:00Z"
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Listar · Estados — Pedidos — Resposta

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Exemplo: "example"
is_initialBooleanoObrigatório: Indica se este é o estado inicial.

Exemplo: false
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
positionNúmero inteiroObrigatório: Posição na coleção ordenada.

Exemplo: 1

Campos adicionais: Não

Listar · Estados — Pedidos — Resposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obrigatório: Exemplo de resposta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Atualizar · Estado — Pedidos — Corpo da requisição

OrderStatusUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

status_idTextoObrigatório

Identificador obtido do catálogo de estados correspondente.

Restrições

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemplo: "example"

Campos adicionais: Não

Listar — Pedidos — Resposta

OrderSummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-10-19T10:00:00Z"
customerCustomerData Obrigatório: Informações do cliente registadas para este recurso.

Exemplo: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obrigatório: Método de entrega e informações associadas.

Exemplo: {"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_amountMoneyData Obrigatório: Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (OrderSummaryData).

Exemplo: "order-0000"
lifecycle_stateOrderLifecycleState Obrigatório: Estado do ciclo de vida do recurso.

Exemplo: "placed"
localeTextoObrigatório: Idioma selecionado para esta requisição.

Exemplo: "pl"
market_idTextoObrigatório: Identificador do mercado retornado pelo endpoint de contexto.

Exemplo: "market-pl"
numberTextoObrigatório: Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "0001"
paymentPaymentData Obrigatório: Detalhes do pagamento registados no pedido.

Exemplo: {"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_taxBooleanoObrigatório: Indica se os preços da lista incluem impostos.

Exemplo: true
shipping_discount_amountMoneyData Obrigatório: Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obrigatório: Estado aceito por esta operação específica.

Exemplo: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obrigatório: Valor anterior aos componentes adicionais indicados na resposta.

Exemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obrigatório: Informações fiscais.

Exemplo: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeTexto nullObrigatório: País fiscal · Dados guardados da encomenda · ISO 3166-1 alpha-2; null.

Exemplo: "PL"
totalMoneyData Obrigatório: Valor total.

Exemplo: {"amount":"329.40","currency":"PLN","minor_units":2}

Campos adicionais: Não

Encomenda · Grupos fiscais

OrderTaxBreakdownData · 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.

groupsLista <OrderTaxGroupData > Obrigatório: Grupos fiscais · source + tax_rate; Desconhecido: null; zero conhecido: 0.

Exemplo: [{"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_taxMoneyData Obrigatório: Imposto não atribuído = order.tax − Σ groups.tax; ±.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

Campos adicionais: Não

Grupos fiscais

OrderTaxGroupData · 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.

grossMoneyData Obrigatório

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

Exemplo: {"amount":"221.40","currency":"PLN","minor_units":2}

netMoneyData nullObrigatório

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

Exemplo: {"amount":"180.00","currency":"PLN","minor_units":2}

sourceTextoObrigatório

Origem: products (Produtos), shipping (Envio).

Restrições

enum: ["products", "shipping"]

Exemplo: "products"

taxMoneyData nullObrigatório

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

Exemplo: {"amount":"41.40","currency":"PLN","minor_units":2}

tax_rateTexto nullObrigatório

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

Exemplo: "0.23"

Campos adicionais: Não

Encomenda · Totais

OrderTotalsData · 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.

before_discountsOrderAmountBreakdownData Obrigatório: Encomenda · Antes dos descontos · net / tax / gross.

Exemplo: {"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}}
discountsOrderAmountBreakdownData Obrigatório: Descontos · net / tax / gross.

Exemplo: {"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}}
orderOrderAmountBreakdownData Obrigatório: Encomenda · Após os descontos · net / tax / gross.

Exemplo: {"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_discountsOrderAmountBreakdownData Obrigatório: Produtos · Descontos · net / tax / gross.

Exemplo: {"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}}
productsOrderAmountBreakdownData Obrigatório: Produtos · Após os descontos · net / tax / gross.

Exemplo: {"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_discountsOrderAmountBreakdownData Obrigatório: Produtos · Antes dos descontos · net / tax / gross.

Exemplo: {"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}}
shippingOrderAmountBreakdownData Obrigatório: Envio · Após os descontos · net / tax / gross.

Exemplo: {"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_discountsOrderAmountBreakdownData Obrigatório: Envio · Antes dos descontos · net / tax / gross.

Exemplo: {"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_discountsOrderAmountBreakdownData Obrigatório: Envio · Descontos · net / tax / gross.

Exemplo: {"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}}

Campos adicionais: Não

Opções de variante associadas ao produto ou aos dados preservados

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Esquema · Esquemas de dados: Pedidos

nameTextoObrigatório: Nome do recurso no contexto correspondente.
valueTextoObrigatório: Valor definido pelo esquema que o contém.

Campos adicionais: Não

OrderDiscountData

OrderDiscountData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

amountMoneyData Obrigatório

Montante bruto · Produtos · Descontos.

Exemplo: {"amount":"12.30","currency":"PLN","minor_units":2}

campaign_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "saved-coupon"

codeTexto nullObrigatório

Código estável legível por programas.

Exemplo: "SAVE"

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["coupon", "promotion"]

Exemplo: "coupon"

nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Saved coupon"

sequenceNúmero inteiro nullOpcional

Ordem de aplicação; null.

Exemplo: 1

shipping_amountMoneyData nullOpcional

Montante bruto · Envio · Descontos; null.

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}

versionNúmero inteiroObrigatório

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

Exemplo: 3

Campos adicionais: Não

Detalhes do pagamento registados no pedido

PaymentData · Esquema · Esquemas de dados: Pedidos

amountMoneyData Obrigatório

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

Exemplo: {"amount":"329.40","currency":"PLN","minor_units":2}

environmentTextoObrigatório

Informações do ambiente associadas ao registo.

Restrições

enum: ["live", "sandbox"]

Exemplo: "live"

method_codeTexto nullObrigatório

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

Exemplo: "payment-old"

method_nameTexto nullObrigatório

Nome do método de entrega ou pagamento.

Exemplo: "Historic method"

paid_atTexto nullObrigatório

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

Texto:format: "date-time"

Exemplo: null

statusOrderPaymentStatus Obrigatório

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

Exemplo: "unpaid"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-10-19T10:00:00Z"

versionNúmero inteiroObrigatório

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

Exemplo: 0

Campos adicionais: Não

Atualizar · Estado do pagamento — Pedidos — Corpo da requisição

PaymentStatusUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 0maximum: 9223372036854775807

Exemplo: 1
reasonTextoObrigatório: Motivo registado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Example"
statusPaymentStatus Obrigatório: Estado aceito por esta operação específica.

Exemplo: "paid"

Campos adicionais: Não

Estado aceito por esta operação específica

PaymentStatus · Esquema · Esquemas de dados: Pedidos

Texto

Restrições

enum: ["unpaid", "paid", "failed", "refunded"]

Campos adicionais: Sim

PickupPointAddressData

PickupPointAddressData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

address_line_1TextoObrigatório: Primeira linha de endereço.

minLength: 1maxLength: 240
cityTextoObrigatório: Cidade ou localidade.

minLength: 1maxLength: 160
postal_codeTextoObrigatório: Código postal.

minLength: 1maxLength: 32

Campos adicionais: Não

PickupPointCoordinatesData

PickupPointCoordinatesData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

latitudeNúmeroObrigatório: WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeNúmeroObrigatório: WGS84 λ (°)

minimum: -180.0maximum: 180.0

Campos adicionais: Não

PickupPointData

PickupPointData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

address_line1TextoObrigatório

Primeira linha de endereço.

cityTextoObrigatório

Cidade ou localidade.

codeTextoObrigatório

Código estável legível por programas.

country_codeTextoObrigatório

Código do país.

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["locker", "pickup_point"]

latitudeNúmero nullObrigatório

WGS84 φ (°)

location_descriptionTexto nullObrigatório

Descrição no idioma selecionado.

longitudeNúmero nullObrigatório

WGS84 λ (°)

nameTextoObrigatório

Nome do recurso no contexto correspondente.

opening_hoursTexto nullObrigatório

Opening hours

operatorTextoObrigatório

Nome do recurso no contexto correspondente.

postal_codeTextoObrigatório

Código postal.

Campos adicionais: Não

PickupPointSummaryData

PickupPointSummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

codeTextoObrigatório

Código estável legível por programas.

Restrições

pattern: "^[A-Za-z0-9_-]{1,63}$"

country_codeTextoObrigatório

Código do país.

Restrições

pattern: "^[A-Z]{2}$"

environmentTextoObrigatório

Informações do ambiente associadas ao registo.

Restrições

enum: ["live", "sandbox"]

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["locker", "pickup_point"]

operatorTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 63

Campos adicionais: Não

Informações do cliente registadas para este recurso

RequestCustomerData · Esquema · Esquemas de dados: Pedidos

emailTextoObrigatório: Endereço de e-mail.

Exemplo: "customer@example.invalid"
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"

Campos adicionais: Não

Método de entrega e informações associadas

ShippingData · Esquema · Esquemas de dados: Pedidos

amountMoneyData Obrigatório

Montante bruto do envio registado na encomenda como MoneyData. Alterações fiscais posteriores não alteram este montante histórico.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obrigatório

Datas de envio e entrega. 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.

Exemplo:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_codeTexto nullObrigatório

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

Exemplo: "shipping-old"

method_nameTexto nullObrigatório

Nome do método de entrega ou pagamento.

Exemplo: "Historic carrier"

pickup_pointPickupPointSummaryData nullObrigatório

Ponto de recolha

Exemplo: null

recipient_modeTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["full_address", "pickup_contact"]

Exemplo: "full_address"

Campos adicionais: Não

ShippingDetailData

ShippingDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

amountMoneyData Obrigatório

Montante bruto do envio registado na encomenda como MoneyData. Alterações fiscais posteriores não alteram este montante histórico.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

datesDeliveryDatesData Obrigatório

Exemplo:

{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData Obrigatório

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

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}

discount_netMoneyData nullObrigatório

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

Exemplo: {"amount":"20.00","currency":"PLN","minor_units":2}

discount_taxMoneyData nullObrigatório

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

Exemplo: {"amount":"4.60","currency":"PLN","minor_units":2}

discountsLista <OrderDeliveryDiscountData > nullObrigatório

Envio · Descontos; []: 0; null: Desconhecido: null; zero conhecido: 0.

Exemplo:

[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]

grossMoneyData Obrigatório

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

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

method_codeTexto nullObrigatório

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

Exemplo: "shipping-old"

method_nameTexto nullObrigatório

Nome do método de entrega ou pagamento.

Exemplo: "Historic carrier"

netMoneyData nullObrigatório

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

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

original_grossMoneyData Obrigatório

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

Exemplo: {"amount":"24.60","currency":"PLN","minor_units":2}

original_netMoneyData nullObrigatório

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

Exemplo: {"amount":"20.00","currency":"PLN","minor_units":2}

original_taxMoneyData nullObrigatório

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

Exemplo: {"amount":"4.60","currency":"PLN","minor_units":2}

pickup_pointDeliveryPickupPointData nullObrigatório

Ponto de recolha

Exemplo: null

recipient_modeTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["full_address", "pickup_contact"]

Exemplo: "full_address"

taxMoneyData nullObrigatório

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

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}

tax_category_idTexto nullObrigatório

Identificador da categoria fiscal · Dados guardados da encomenda; null.

Exemplo: "standard"

tax_category_nameTexto nullObrigatório

Nome guardado da categoria fiscal; null.

Exemplo: "VAT 23%"

tax_rateTexto nullObrigatório

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

Exemplo: "0.23"

Campos adicionais: Não