Esquemas de datos: Pedidos

Esquemas de datos: Pedidos. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Dirección de entrega

AddressData · Esquema · Esquemas de datos: Pedidos

address_line_1Cadena de texto nullObligatorio: Primera línea de dirección.
address_line_2Cadena de texto nullObligatorio: Información adicional de la dirección.
cityCadena de texto nullObligatorio: Ciudad o localidad.
country_codeCadena de texto nullObligatorio: Código del país.
first_nameCadena de texto nullObligatorio: Nombre.
house_numberCadena de texto nullObligatorio: Número del edificio o de la vivienda.
last_nameCadena de texto nullObligatorio: Apellidos.
phoneCadena de texto nullObligatorio: Número de teléfono.
postal_codeCadena de texto nullObligatorio: Código postal.
regionCadena de texto nullObligatorio: Región administrativa.
streetCadena de texto nullObligatorio: Nombre de la calle.

Campos adicionales: No

Listar — Pedidos — Respuesta

ApiResponse_list_OrderSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <OrderSummaryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_OrderSummaryData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Obtener — Pedidos — Respuesta

ApiResponse_OrderDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataOrderDetailData Obligatorio: Ejemplo de respuesta · OrderDetailData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Información del cliente registrada para este recurso

CustomerData · Esquema · Esquemas de datos: Pedidos

emailCadena de textoObligatorio: Dirección de correo electrónico.

Ejemplo: "customer@example.invalid"
first_nameCadena de texto nullObligatorio: Nombre.

Ejemplo: "Example"
last_nameCadena de texto nullObligatorio: Apellidos.

Ejemplo: "Example"
phoneCadena de texto nullObligatorio: Número de teléfono.

Ejemplo: null

Campos adicionales: No

Fechas de envío y entrega

DeliveryDatesData · La lista y el detalle de pedidos incluyen delivery.dates. Las fechas YYYY-MM-DD son previstas y no confirman el envío. Las fechas actuales tienen prioridad; los pedidos antiguos usan la estimación guardada. Los valores borrados o desconocidos son null. El detalle también incluye todas las líneas e imágenes de productos.

dispatch_timezoneCadena de texto nullObligatorio: Zona horaria del envío (IANA; null).

Ejemplo: "Europe/Warsaw"
estimated_delivery_fromCadena de texto nullObligatorio: Inicio de la entrega estimada (YYYY-MM-DD; null).

Cadena de texto:format: "date"

Ejemplo: "2026-10-20"
estimated_delivery_toCadena de texto nullObligatorio: Fin de la entrega estimada (YYYY-MM-DD; null).

Cadena de texto:format: "date"

Ejemplo: "2026-10-21"
planned_dispatch_onCadena de texto nullObligatorio: Fecha prevista de envío (YYYY-MM-DD; null).

Cadena de texto:format: "date"

Ejemplo: "2026-10-19"

Campos adicionales: No

DeliveryPickupPointData

DeliveryPickupPointData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

addressPickupPointAddressData Obligatorio

Dirección de entrega.

codeCadena de textoObligatorio

Código estable legible por programas.

Restricciones

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

coordinatesPickupPointCoordinatesData nullObligatorio

Valor definido por el esquema que lo contiene.

country_codeCadena de textoObligatorio

Código del país.

Restricciones

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

environmentCadena de textoObligatorio

Información del entorno asociada al registro.

Restricciones

enum: ["live", "sandbox"]

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["locker", "pickup_point"]

location_descriptionCadena de texto nullObligatorio

Descripción en el idioma seleccionado.

Cadena de texto:maxLength: 1000

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 160

opening_hoursCadena de texto nullObligatorio

Opening hours

Cadena de texto:maxLength: 500

operatorCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 63

verified_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

Campos adicionales: No

Información de la factura

InvoiceData · Esquema · Esquemas de datos: Pedidos

address_line_1Cadena de texto nullObligatorio: Primera línea de dirección.
address_line_2Cadena de texto nullObligatorio: Información adicional de la dirección.
cityCadena de texto nullObligatorio: Ciudad o localidad.
company_nameCadena de texto nullObligatorio: Nombre de la empresa.
country_codeCadena de texto nullObligatorio: Código del país.
house_numberCadena de texto nullObligatorio: Número del edificio o de la vivienda.
postal_codeCadena de texto nullObligatorio: Código postal.
regionCadena de texto nullObligatorio: Región administrativa.
streetCadena de texto nullObligatorio: Nombre de la calle.
tax_identifierCadena de texto nullObligatorio: Número de identificación fiscal.
tax_schemeCadena de texto nullObligatorio: Esquema de cálculo de impuestos.

Campos adicionales: No

Importe neto / Importe del impuesto / Importe bruto

OrderAmountBreakdownData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

grossMoneyData Obligatorio: Importe bruto · Después de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullObligatorio: Importe neto · Después de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullObligatorio: Importe del impuesto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

Campos adicionales: No

Envío · Descuentos

OrderDeliveryDiscountData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

amountMoneyData Obligatorio

Importe bruto · Envío · Descuentos.

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

campaign_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve.

Ejemplo: "saved-coupon"

codeCadena de texto nullObligatorio

Código estable legible por programas.

Ejemplo: "SAVE"

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["coupon", "promotion"]

Ejemplo: "coupon"

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Saved coupon"

sequenceNúmero entero nullObligatorio

Posición en la colección ordenada.

Ejemplo: 1

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 3

Campos adicionales: No

Obtener — Pedidos — Respuesta

OrderDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-10-19T10:00:00Z"
customerCustomerData Obligatorio: Información del cliente registrada para este recurso.

Ejemplo: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Obligatorio: Método de entrega e información asociada.

Ejemplo: {"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 Obligatorio: Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsLista <OrderDiscountData > Obligatorio: Descuentos

Ejemplo: [{"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}]
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (OrderDetailData).

Ejemplo: "order-0000"
invoiceInvoiceData nullObligatorio: Información de la factura.

Ejemplo: null
invoice_requestedBooleanoObligatorio: Indica si se solicitó una factura.

Ejemplo: false
lifecycle_stateOrderLifecycleState Obligatorio: Estado del ciclo de vida del recurso.

Ejemplo: "placed"
linesLista <OrderLineData > Obligatorio: Datos de las líneas de pedido conservados al registrarlo.

Ejemplo: [{"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":[]}]
localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.

Ejemplo: "pl"
market_idCadena de textoObligatorio: Identificador del mercado devuelto por el endpoint de contexto.

Ejemplo: "market-pl"
numberCadena de textoObligatorio: Número de pedido o solicitud mostrado al usuario.

Ejemplo: "0001"
paymentPaymentData Obligatorio: Detalles del pago registrados en el pedido.

Ejemplo: {"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 nullObligatorio: Punto de retiro

Ejemplo: null
prices_include_taxBooleanoObligatorio: Indica si los precios de la lista incluyen impuestos.

Ejemplo: true
shipping_addressAddressData nullObligatorio: Dirección de entrega.

Ejemplo: null
shipping_discount_amountMoneyData Obligatorio: Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatorio: Estado admitido por esta operación concreta.

Ejemplo: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatorio: Importe anterior a los componentes adicionales indicados en la respuesta.

Ejemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatorio: Información fiscal.

Ejemplo: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Obligatorio: Grupos fiscales · source + tax_rate; unallocated_tax.

Ejemplo: {"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_codeCadena de texto nullObligatorio: País fiscal · Datos guardados del pedido · ISO 3166-1 alpha-2; null.

Ejemplo: "PL"
totalMoneyData Obligatorio: Importe total.

Ejemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Obligatorio: Totales · net / tax / gross; Antes de descuentos / Después de descuentos.

Ejemplo: {"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 adicionales: No

Metadatos y URL de la imagen

OrderImageData · Esquema · Esquemas de datos: Pedidos

altCadena de texto nullObligatorio: Texto alternativo de una imagen.
sourceCadena de textoOpcional: Origen de la actividad registrada.

const: "current_catalog"

Valor predeterminado: "current_catalog"
urlCadena de textoObligatorio: URL del recurso.

Campos adicionales: No

Estado del ciclo de vida del recurso

OrderLifecycleState · Esquema · Esquemas de datos: Pedidos

Cadena de texto

Restricciones

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

Campos adicionales: Sí

Datos de las líneas de pedido conservados al registrarlo

OrderLineData · Esquema · Esquemas de datos: Pedidos

discount_amountMoneyData Obligatorio: Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Obligatorio: Importe bruto · Descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullObligatorio: Importe neto · Descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullObligatorio: Importe del impuesto · Descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsLista <OrderDiscountData > Obligatorio: Descuentos · net / tax / gross.

Ejemplo: [{"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 adicionales: Cadena de textoObligatorio: Códigos de identificación del producto.

Ejemplo: {}
imageOrderImageData nullObligatorio: Metadatos y URL de la imagen.

Ejemplo: null
line_idCadena de textoObligatorio: Identificador estable de la línea del pedido.

Ejemplo: "saved-line-a"
manual_discountOrderManualDiscountData nullObligatorio: Descuento manual; null.

Ejemplo: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Saved A"
original_totalMoneyData Obligatorio: Importe total.

Ejemplo: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Obligatorio: Importe bruto · Productos · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullObligatorio: Importe neto · Productos · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullObligatorio: Importe del impuesto · Productos · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"46.00","currency":"PLN","minor_units":2}
positionNúmero enteroObligatorio: Posición en la colección ordenada.

Ejemplo: 1
product_idCadena de textoObligatorio: Identificador del producto.

Ejemplo: "product-api"
quantityNúmero enteroObligatorio: Número de unidades.

Ejemplo: 2
skuCadena de textoObligatorio: Código de referencia de inventario.

Ejemplo: "A"
taxMoneyData nullObligatorio: Importe del impuesto · Una unidad · Datos guardados del pedido; tax ≠ unit_tax; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idCadena de texto nullObligatorio: Identificador de categoría fiscal · Datos guardados del pedido; null.

Ejemplo: "standard"
tax_category_nameCadena de texto nullObligatorio: Nombre guardado de la categoría fiscal; null.

Ejemplo: "VAT 23%"
tax_rateCadena de texto nullObligatorio: tax_rate · Datos guardados del pedido: "0.23" = 23%; "0" ≠ null.

Ejemplo: "0.23"
totalMoneyData Obligatorio: Importe total.

Ejemplo: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Obligatorio: Importe bruto · Productos · Después de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullObligatorio: Importe neto · Productos · Después de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullObligatorio: Importe del impuesto · Productos · Después de descuentos · Datos guardados del pedido; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Obligatorio: Importe bruto · Una unidad · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullObligatorio: Importe neto · Una unidad · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatorio: Precio por unidad.

Ejemplo: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullObligatorio: Importe del impuesto · Una unidad · Antes de descuentos; Desconocido: null; cero conocido: 0.

Ejemplo: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idCadena de texto nullObligatorio: Identificador de la variante del producto.

Ejemplo: null
variant_optionsLista <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Obligatorio: Opciones de variante asociadas al producto o a sus datos registrados.

Ejemplo: []

Campos adicionales: No

Descuento manual

OrderManualDiscountData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

amountMoneyData Obligatorio

Importe bruto · Descuento manual · Datos guardados del pedido.

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

kindCadena de textoObligatorio

Tipo de descuento: percentage / fixed.

Restricciones

enum: ["percentage", "fixed"]

Ejemplo: "fixed"

valueCadena de textoObligatorio

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

Ejemplo: "12.30"

Campos adicionales: No

Estado admitido por esta operación concreta

OrderPaymentStatus · Esquema · Esquemas de datos: Pedidos

Cadena de texto

Restricciones

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

Campos adicionales: Sí

Estado admitido por esta operación concreta

OrderStatusData · Esquema · Esquemas de datos: Pedidos

idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (OrderStatusData).

Ejemplo: "status-0"
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Status 0"
updated_atCadena de textoObligatorio: Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-10-19T10:00:00Z"
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Listar · Estados — Pedidos — Respuesta

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).

Ejemplo: "example"
is_initialBooleanoObligatorio: Indica si este es el estado inicial.

Ejemplo: false
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
positionNúmero enteroObligatorio: Posición en la colección ordenada.

Ejemplo: 1

Campos adicionales: No

Listar · Estados — Pedidos — Respuesta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Obligatorio: Ejemplo de respuesta · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Ejemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Actualizar · Estado — Pedidos — Cuerpo de la solicitud

OrderStatusUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

status_idCadena de textoObligatorio

Identificador obtenido del catálogo de estados correspondiente.

Restricciones

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

Ejemplo: "example"

Campos adicionales: No

Listar — Pedidos — Respuesta

OrderSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-10-19T10:00:00Z"
customerCustomerData Obligatorio: Información del cliente registrada para este recurso.

Ejemplo: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Obligatorio: Método de entrega e información asociada.

Ejemplo: {"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 Obligatorio: Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (OrderSummaryData).

Ejemplo: "order-0000"
lifecycle_stateOrderLifecycleState Obligatorio: Estado del ciclo de vida del recurso.

Ejemplo: "placed"
localeCadena de textoObligatorio: Idioma seleccionado para esta solicitud.

Ejemplo: "pl"
market_idCadena de textoObligatorio: Identificador del mercado devuelto por el endpoint de contexto.

Ejemplo: "market-pl"
numberCadena de textoObligatorio: Número de pedido o solicitud mostrado al usuario.

Ejemplo: "0001"
paymentPaymentData Obligatorio: Detalles del pago registrados en el pedido.

Ejemplo: {"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_taxBooleanoObligatorio: Indica si los precios de la lista incluyen impuestos.

Ejemplo: true
shipping_discount_amountMoneyData Obligatorio: Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Obligatorio: Estado admitido por esta operación concreta.

Ejemplo: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Obligatorio: Importe anterior a los componentes adicionales indicados en la respuesta.

Ejemplo: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Obligatorio: Información fiscal.

Ejemplo: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeCadena de texto nullObligatorio: País fiscal · Datos guardados del pedido · ISO 3166-1 alpha-2; null.

Ejemplo: "PL"
totalMoneyData Obligatorio: Importe total.

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

Campos adicionales: No

Pedido · Grupos fiscales

OrderTaxBreakdownData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

groupsLista <OrderTaxGroupData > Obligatorio: Grupos fiscales · source + tax_rate; Desconocido: null; cero conocido: 0.

Ejemplo: [{"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 Obligatorio: Impuesto sin asignar = order.tax − Σ groups.tax; ±.

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

Campos adicionales: No

Grupos fiscales

OrderTaxGroupData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

grossMoneyData Obligatorio

Importe bruto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

netMoneyData nullObligatorio

Importe neto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

sourceCadena de textoObligatorio

Origen: products (Productos), shipping (Envío).

Restricciones

enum: ["products", "shipping"]

Ejemplo: "products"

taxMoneyData nullObligatorio

Importe del impuesto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

tax_rateCadena de texto nullObligatorio

tax_rate · Datos guardados del pedido: "0.23" = 23%; "0" ≠ null.

Ejemplo: "0.23"

Campos adicionales: No

Pedido · Totales

OrderTotalsData · Los importes y tipos impositivos proceden del pedido guardado, incluidas las correcciones de líneas. Los datos históricos ausentes son null y no se sustituyen por los tipos actuales del catálogo. Los importes siguen siendo cadenas decimales.

before_discountsOrderAmountBreakdownData Obligatorio: Pedido · Antes de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Pedido · Después de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Productos · Descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Productos · Después de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Productos · Antes de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Envío · Después de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Envío · Antes de descuentos · net / tax / gross.

Ejemplo: {"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 Obligatorio: Envío · Descuentos · net / tax / gross.

Ejemplo: {"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 adicionales: No

Opciones de variante asociadas al producto o a sus datos registrados

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Esquema · Esquemas de datos: Pedidos

nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.
valueCadena de textoObligatorio: Valor definido por el esquema que lo contiene.

Campos adicionales: No

OrderDiscountData

OrderDiscountData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

amountMoneyData Obligatorio

Importe bruto · Productos · Descuentos.

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

campaign_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve.

Ejemplo: "saved-coupon"

codeCadena de texto nullObligatorio

Código estable legible por programas.

Ejemplo: "SAVE"

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["coupon", "promotion"]

Ejemplo: "coupon"

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Saved coupon"

sequenceNúmero entero nullOpcional

Orden de aplicación; null.

Ejemplo: 1

shipping_amountMoneyData nullOpcional

Importe bruto · Envío · Descuentos; null.

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 3

Campos adicionales: No

Detalles del pago registrados en el pedido

PaymentData · Esquema · Esquemas de datos: Pedidos

amountMoneyData Obligatorio

payment.amount es el total del pedido. El estado del pago no determina importes pagados, reembolsados ni pendientes.

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

environmentCadena de textoObligatorio

Información del entorno asociada al registro.

Restricciones

enum: ["live", "sandbox"]

Ejemplo: "live"

method_codeCadena de texto nullObligatorio

Código del método de entrega o pago.

Ejemplo: "payment-old"

method_nameCadena de texto nullObligatorio

Nombre del método de entrega o pago.

Ejemplo: "Historic method"

paid_atCadena de texto nullObligatorio

Fecha y hora en que el pago se marcó como pagado.

Cadena de texto:format: "date-time"

Ejemplo: null

statusOrderPaymentStatus Obligatorio

Estado admitido por esta operación concreta.

Ejemplo: "unpaid"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 0

Campos adicionales: No

Actualizar · Estado del pago — Pedidos — Cuerpo de la solicitud

PaymentStatusUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio: Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 0maximum: 9223372036854775807

Ejemplo: 1
reasonCadena de textoObligatorio: Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Example"
statusPaymentStatus Obligatorio: Estado admitido por esta operación concreta.

Ejemplo: "paid"

Campos adicionales: No

Estado admitido por esta operación concreta

PaymentStatus · Esquema · Esquemas de datos: Pedidos

Cadena de texto

Restricciones

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

Campos adicionales: Sí

PickupPointAddressData

PickupPointAddressData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

address_line_1Cadena de textoObligatorio: Primera línea de dirección.

minLength: 1maxLength: 240
cityCadena de textoObligatorio: Ciudad o localidad.

minLength: 1maxLength: 160
postal_codeCadena de textoObligatorio: Código postal.

minLength: 1maxLength: 32

Campos adicionales: No

PickupPointCoordinatesData

PickupPointCoordinatesData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

latitudeNúmeroObligatorio: WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeNúmeroObligatorio: WGS84 λ (°)

minimum: -180.0maximum: 180.0

Campos adicionales: No

PickupPointData

PickupPointData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

address_line1Cadena de textoObligatorio

Primera línea de dirección.

cityCadena de textoObligatorio

Ciudad o localidad.

codeCadena de textoObligatorio

Código estable legible por programas.

country_codeCadena de textoObligatorio

Código del país.

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["locker", "pickup_point"]

latitudeNúmero nullObligatorio

WGS84 φ (°)

location_descriptionCadena de texto nullObligatorio

Descripción en el idioma seleccionado.

longitudeNúmero nullObligatorio

WGS84 λ (°)

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

opening_hoursCadena de texto nullObligatorio

Opening hours

operatorCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

postal_codeCadena de textoObligatorio

Código postal.

Campos adicionales: No

PickupPointSummaryData

PickupPointSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

codeCadena de textoObligatorio

Código estable legible por programas.

Restricciones

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

country_codeCadena de textoObligatorio

Código del país.

Restricciones

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

environmentCadena de textoObligatorio

Información del entorno asociada al registro.

Restricciones

enum: ["live", "sandbox"]

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["locker", "pickup_point"]

operatorCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 63

Campos adicionales: No

Información del cliente registrada para este recurso

RequestCustomerData · Esquema · Esquemas de datos: Pedidos

emailCadena de textoObligatorio: Dirección de correo electrónico.

Ejemplo: "customer@example.invalid"
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"

Campos adicionales: No

Método de entrega e información asociada

ShippingData · Esquema · Esquemas de datos: Pedidos

amountMoneyData Obligatorio

Importe de envío con impuestos registrado en el pedido como MoneyData. Los cambios fiscales posteriores no modifican este importe histórico.

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

datesDeliveryDatesData Obligatorio

Fechas de envío y entrega. La lista y el detalle de pedidos incluyen delivery.dates. Las fechas YYYY-MM-DD son previstas y no confirman el envío. Las fechas actuales tienen prioridad; los pedidos antiguos usan la estimación guardada. Los valores borrados o desconocidos son null. El detalle también incluye todas las líneas e imágenes de productos.

Ejemplo:

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

method_codeCadena de texto nullObligatorio

Código del método de entrega o pago.

Ejemplo: "shipping-old"

method_nameCadena de texto nullObligatorio

Nombre del método de entrega o pago.

Ejemplo: "Historic carrier"

pickup_pointPickupPointSummaryData nullObligatorio

Punto de retiro

Ejemplo: null

recipient_modeCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["full_address", "pickup_contact"]

Ejemplo: "full_address"

Campos adicionales: No

ShippingDetailData

ShippingDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

amountMoneyData Obligatorio

Importe de envío con impuestos registrado en el pedido como MoneyData. Los cambios fiscales posteriores no modifican este importe histórico.

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

datesDeliveryDatesData Obligatorio

Ejemplo:

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

discount_grossMoneyData Obligatorio

Importe bruto · Descuentos; Desconocido: null; cero conocido: 0.

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

discount_netMoneyData nullObligatorio

Importe neto · Descuentos; Desconocido: null; cero conocido: 0.

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

discount_taxMoneyData nullObligatorio

Importe del impuesto · Descuentos; Desconocido: null; cero conocido: 0.

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

discountsLista <OrderDeliveryDiscountData > nullObligatorio

Envío · Descuentos; []: 0; null: Desconocido: null; cero conocido: 0.

Ejemplo:

[{"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 Obligatorio

Importe bruto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

method_codeCadena de texto nullObligatorio

Código del método de entrega o pago.

Ejemplo: "shipping-old"

method_nameCadena de texto nullObligatorio

Nombre del método de entrega o pago.

Ejemplo: "Historic carrier"

netMoneyData nullObligatorio

Importe neto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

original_grossMoneyData Obligatorio

Importe bruto · Envío · Antes de descuentos; Desconocido: null; cero conocido: 0.

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

original_netMoneyData nullObligatorio

Importe neto · Envío · Antes de descuentos; Desconocido: null; cero conocido: 0.

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

original_taxMoneyData nullObligatorio

Importe del impuesto · Envío · Antes de descuentos; Desconocido: null; cero conocido: 0.

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

pickup_pointDeliveryPickupPointData nullObligatorio

Punto de retiro

Ejemplo: null

recipient_modeCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum: ["full_address", "pickup_contact"]

Ejemplo: "full_address"

taxMoneyData nullObligatorio

Importe del impuesto · Después de descuentos; Desconocido: null; cero conocido: 0.

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

tax_category_idCadena de texto nullObligatorio

Identificador de categoría fiscal · Datos guardados del pedido; null.

Ejemplo: "standard"

tax_category_nameCadena de texto nullObligatorio

Nombre guardado de la categoría fiscal; null.

Ejemplo: "VAT 23%"

tax_rateCadena de texto nullObligatorio

tax_rate · Datos guardados del pedido: "0.23" = 23%; "0" ≠ null.

Ejemplo: "0.23"

Campos adicionales: No