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

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

ApiResponse_OrderFileListData_

ApiResponse_OrderFileListData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
dataOrderFileListData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"files":[{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

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

Campos adicionais: Não

ApiResponse_OrderReleaseListData_

ApiResponse_OrderReleaseListData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
dataOrderReleaseListData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"releases":[{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}],"updates_pending":false}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

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

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

CurrentReleaseData

CurrentReleaseData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
acquiredBooleanoObrigatório

Acesso após a compra (true / false)

changelogTextoObrigatório

Descrição das alterações

covered_by_purchaseBooleanoObrigatório

Acesso após a compra (true / false)

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

published_atTextoObrigatório

Publicar versão · UTC

format: "date-time"
requires_new_purchaseBooleanoObrigatório

Sem acesso a ficheiros adicionados após a compra · requires_new_purchase

sequenceNúmero inteiroObrigatório

Posição na coleção ordenada.

version_labelTextoObrigatório

Versão

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

DeliveryContentDeletion

DeliveryContentDeletion · Exclua o conteúdo definitivamente, preservando o histórico. O código não volta ao stock disponível.
expected_versionNúmero inteiroObrigatório

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

minimum: 1
Exemplo: 1
reasonTextoObrigatório

Motivo registado para a alteração.

minLength: 1maxLength: 500
Exemplo: "Withdraw a revoked license"

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

DeliveryReplacement

DeliveryReplacement · Escolha uma unidade livre existente. A substituição não reinicia o prazo de armazenamento.
expected_unit_versionNúmero inteiroObrigatório

Versão atual da unidade livre de substituição.

minimum: 1
Exemplo: 1
expected_versionNúmero inteiroObrigatório

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

minimum: 1
Exemplo: 1
reasonTextoObrigatório

Motivo registado para a alteração.

minLength: 1maxLength: 500
Exemplo: "Replace an invalid activation code"
replacement_unit_idTextoObrigatório

ID de uma unidade livre existente para substituição.

format: "uuid"
Exemplo: "00000000-0000-4000-8000-000000000008"

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

ApiResponse[list[DeliveryData]]

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · Consulte as unidades atribuídas sem revelar os códigos. O reembolso retira o acesso apenas dos itens afetados.
dataLista <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData > Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: [{"can_download":true,"content_state":"present","delete_due_at":null,"filename":null,"first_available_at":"2026-11-03T12:00:00Z","generation":1,"id":"00000000-0000-4000-8000-000000000005","kind":"code","line_id":"line-example","order_id":"order-example","payload_id":"00000000-0000-4000-8000-000000000012","product_id":"example","reason":"","size_bytes":null,"state":"available","unit_id":"00000000-0000-4000-8000-000000000011","unit_ordinal":1,"variant_id":null,"version":2}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Campos adicionais: Não

DeliveryData

shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · Consulte as unidades atribuídas sem revelar os códigos. O reembolso retira o acesso apenas dos itens afetados.
can_downloadBooleanoObrigatório

Descarregar (true / false)

Exemplo: true
content_stateTextoObrigatório

Estado do conteúdo: present / deleting / deleted.

Exemplo: "present"
delete_due_atTexto nullObrigatório

Exclusão programada do ficheiro; null a desativa.

Texto:format: "date-time"
Exemplo: null
filenameTexto nullObrigatório

Ficheiro

Exemplo: null
first_available_atTexto nullObrigatório

Primeiro acesso desta compra; a substituição não reinicia o prazo.

Texto:format: "date-time"
Exemplo: "2026-11-03T12:00:00Z"
generationNúmero inteiroObrigatório

Geração da atribuição; aumenta na substituição.

Exemplo: 1
idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"
Exemplo: "00000000-0000-4000-8000-000000000005"
kindTexto nullObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Exemplo: "code"
line_idTextoObrigatório

Identificador estável da linha da encomenda.

Exemplo: "line-example"
order_idTextoObrigatório

Identificador do pedido relacionado.

Exemplo: "order-example"
payload_idTextoObrigatório

ID do conteúdo; não é uma URL pública de download.

format: "uuid"
Exemplo: "00000000-0000-4000-8000-000000000012"
product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"
reasonTextoObrigatório

Motivo registado para a alteração.

Exemplo: ""
size_bytesNúmero inteiro nullObrigatório

Tamanho em bytes

Exemplo: null
stateTextoObrigatório

Estado

Exemplo: "available"
unit_idTextoObrigatório

ID de um código ou ficheiro individual.

format: "uuid"
Exemplo: "00000000-0000-4000-8000-000000000011"
unit_ordinalNúmero inteiroObrigatório

Número da unidade comprada dentro do item do encomenda.

Exemplo: 1
variant_idTexto nullObrigatório

Identificador da variante do produto.

Exemplo: null
versionNúmero inteiroObrigatório

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

Exemplo: 2

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

OrderFileData

OrderFileData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
can_downloadBooleanoObrigatório

Descarregar (true / false)

Exemplo: true
categoryFileCategory Obrigatório

Categoria do ficheiro: internal / customer_document / digital

Exemplo: "digital"
filenameTextoObrigatório

Ficheiro

Exemplo: "manual.pdf"
idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "example"
labelTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Manual"
line_idTextoObrigatório

Identificador estável da linha da encomenda.

Exemplo: "example"
mime_typeTextoObrigatório

Tipo de conteúdo da multimédia.

Exemplo: "application/pdf"
product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"
purchase_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · purchase_id

Exemplo: "00000000-0000-4000-8000-000000000001"
reasonTextoObrigatório

Motivo registado para a alteração.

Exemplo: "paid"
sha256TextoObrigatório

SHA-256 (hex, 64)

Exemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNúmero inteiroObrigatório

Tamanho em bytes

minimum: 1maximum: 262144000
Exemplo: 46
source_file_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · source_file_id

Exemplo: "00000000-0000-4000-8000-000000000001"
source_version_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · source_version_id

Exemplo: "00000000-0000-4000-8000-000000000001"
source_version_numberNúmero inteiroObrigatório

Versão

minimum: 1
Exemplo: 1
stateTextoObrigatório

Estado

Exemplo: "active"

Campos adicionais: Não

OrderFileListData

OrderFileListData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
filesLista <OrderFileData > Obrigatório

Ficheiros do produto

Exemplo: [{"can_download":true,"category":"digital","filename":"manual.pdf","id":"example","label":"Manual","line_id":"example","mime_type":"application/pdf","product_id":"example","purchase_id":"00000000-0000-4000-8000-000000000001","reason":"paid","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"source_file_id":"00000000-0000-4000-8000-000000000001","source_version_id":"00000000-0000-4000-8000-000000000001","source_version_number":1,"state":"active"}]
updates_pendingBooleanoObrigatório

Acesso a ficheiros futuros após a compra · updates_pending

Exemplo: false

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

OrderReleaseData

OrderReleaseData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
access_reasonTextoObrigatório

Acesso após a compra · Motivo registado para a alteração.

Exemplo: "paid"
access_stateTextoObrigatório

Acesso após a compra · Estado

Exemplo: "active"
current_releaseCurrentReleaseData nullObrigatório

Versões digitais · current_release

Exemplo: null
grant_reasonTextoObrigatório

Acesso após a compra · Motivo registado para a alteração.

Exemplo: "purchase"
granted_atTextoObrigatório

Acesso após a compra · UTC

format: "date-time"
Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "example"
line_idTextoObrigatório

Identificador estável da linha da encomenda.

Exemplo: "example"
manifest_sha256TextoObrigatório

Versões digitais · SHA-256

Exemplo: "1111111111111111111111111111111111111111111111111111111111111111"
product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"
published_atTextoObrigatório

Publicar versão · UTC

format: "date-time"
Exemplo: "2026-01-01T12:00:00Z"
purchase_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · purchase_id

Exemplo: "00000000-0000-4000-8000-000000000001"
release_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · release_id

Exemplo: "00000000-0000-4000-8000-000000000001"
release_sequenceNúmero inteiroObrigatório

Versões digitais · Posição na coleção ordenada.

Exemplo: 1
update_daysNúmero inteiro nullObrigatório

Número de dias (days; null)

Exemplo: 365
update_modeTextoObrigatório

Acesso a ficheiros futuros após a compra: none / period / unlimited

Exemplo: "period"
update_monthsNúmero inteiro nullObrigatório

Meses (months; null)

Exemplo: null
updates_untilTexto nullObrigatório

Acesso a ficheiros futuros após a compra · UTC

Texto:format: "date-time"
Exemplo: "2027-01-01T12:00:00Z"
version_labelTextoObrigatório

Versão

Exemplo: "1.0"

Campos adicionais: Não

OrderReleaseListData

OrderReleaseListData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API. Envie os ficheiros como multipart/form-data após criar upload_id e associe-os ao produto. A transferência exige um token Bearer e permissão para category; a resposta contém os bytes, sem endereço público nem palavra-passe. Para mode=period escolha days (1–3650) ou o anterior months, nunca ambos. As condições ficam registadas na compra; o reembolso retira o acesso apenas à linha reembolsada.
releasesLista <OrderReleaseData > Obrigatório

Versões digitais

Exemplo: [{"access_reason":"paid","access_state":"active","current_release":null,"grant_reason":"purchase","granted_at":"2026-01-01T12:00:00Z","id":"example","line_id":"example","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","product_id":"example","published_at":"2026-01-01T12:00:00Z","purchase_id":"00000000-0000-4000-8000-000000000001","release_id":"00000000-0000-4000-8000-000000000001","release_sequence":1,"update_days":365,"update_mode":"period","update_months":null,"updates_until":"2027-01-01T12:00:00Z","version_label":"1.0"}]
updates_pendingBooleanoObrigatório

Acesso a ficheiros futuros após a compra · updates_pending

Exemplo: false

Campos adicionais: Não

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: "status-0"
is_initialBooleanoObrigatório

Indica se este é o estado inicial.

Exemplo: true
nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "New"
positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 0

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":"status-0","is_initial":true,"name":"New","position":0},{"created_at":"2026-01-01T12:00:00Z","id":"status-1","is_initial":false,"name":"Processing","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: "status-1"

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: 0
reasonTextoObrigatório

Motivo registado para a alteração.

minLength: 1maxLength: 500
Exemplo: "Bank transfer confirmed"
statusPaymentStatus Obrigatório

Estado aceito por esta operação específica. unpaid: por pagar; paid: pago; failed: pagamento falhado; refunded: reembolsado.

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", "address_only", "name_contact", "contact_only"]
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

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"}
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", "address_only", "name_contact", "contact_only"]
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