Saltar al contenido
ShopentlyLearn
Español latinoamericano

Obtener — Pedidos

Consulta los datos de «Pedidos». El resultado depende de los parámetros de esta operación.

GET/api/v1/orders/{order_id}

Autenticación
Bearer
Disponible desde
BASIC
Permisos necesarios
orders.order:read

Ejemplos de código

Ejemplo de solicitud

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Ejemplo de respuesta 200

JSON
{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "locale": "pl",
    "market_id": "market-pl",
    "number": "0001",
    "payment": {
      "amount": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "environment": "live",
      "method_code": "payment-old",
      "method_name": "Historic method",
      "paid_at": null,
      "status": "unpaid",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 0
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "shipping_discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "status": {
      "id": "status-0",
      "name": "Status 0",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 1
    },
    "subtotal": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax": {
      "amount": "49.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Cómo funciona

  • La colección ofrece resúmenes de pedidos y filtros por número, estado, estado de pago y fecha de creación.
  • 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.
  • Obtén identificadores de estado válidos de /api/v1/order-statuses.
  • El estado del pedido y el estado de pago utilizan endpoints PATCH y permisos independientes.
  • Cambiar el estado de pago registrado no realiza un cargo en una tarjeta ni emite un reembolso a través de un proveedor de pagos.

Escrituras seguras

Permisos y planes

Pedido · Totales

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.

La lista devuelve resúmenes. Obtén GET /api/v1/orders/{order_id} para cada resultado y exporta el detalle financiero completo. Los reintentos GET son limitados y respetan Retry-After. La exportación por fecha de creación no sincroniza correcciones posteriores.

  • tax_country_code · País fiscal · Datos guardados del pedido · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Una unidad · Antes de descuentos; lines[].original_total_* · Antes de descuentos; lines[].total_* · Después de descuentos.
  • lines[].discount_* · Descuentos; manual_discount · Descuento manual; percentage "10" = 10%.
  • delivery.net / tax / gross · Después de descuentos; delivery.original_* · Antes de descuentos; delivery.discount_* · Descuentos.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Desconocido: null; cero conocido: 0.
  • totals · Totales; tax_breakdown.groups · Grupos fiscales; Impuesto sin asignar = order.tax − Σ groups.tax; ±.

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

Parámetros

Parámetros de ruta

order_idCadena de textoObligatorio

Identificador del pedido relacionado.

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

Esta operación no acepta un cuerpo JSON.

Respuestas

Respuesta 200

Modelo completo: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatorio

Contenido de una respuesta correcta.

Campos · data

Modelo completo: OrderDetailData

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"
customerCustomerData Obligatorio

Información del cliente registrada para este recurso.

Campos · customer

Modelo completo: CustomerData

emailCadena de textoObligatorio

Dirección de correo electrónico.

first_nameCadena de texto nullObligatorio

Nombre.

last_nameCadena de texto nullObligatorio

Apellidos.

phoneCadena de texto nullObligatorio

Número de teléfono.

deliveryShippingDetailData Obligatorio

Método de entrega e información asociada.

Campos · delivery

Modelo completo: ShippingDetailData

amountMoneyData Obligatorio

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

datesDeliveryDatesData Obligatorio

Fechas de envío y entrega

discount_grossMoneyData Obligatorio

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

discount_netMoneyData nullObligatorio

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

discount_taxMoneyData nullObligatorio

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

discountsLista <OrderDeliveryDiscountData > nullObligatorio

Descuentos

grossMoneyData Obligatorio

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

method_codeCadena de texto nullObligatorio

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

method_nameCadena de texto nullObligatorio

Nombre del método de entrega o pago.

netMoneyData nullObligatorio

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

original_grossMoneyData Obligatorio

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

original_netMoneyData nullObligatorio

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

original_taxMoneyData nullObligatorio

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

pickup_pointDeliveryPickupPointData nullObligatorio

Punto de retiro

recipient_modeCadena de textoObligatorio

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

Restricciones
enum
["full_address", "pickup_contact"]
taxMoneyData nullObligatorio

Información fiscal.

tax_category_idCadena de texto nullObligatorio

Identificador de la categoría fiscal.

tax_category_nameCadena de texto nullObligatorio

Nombre guardado de la categoría fiscal; null.

tax_rateCadena de texto nullObligatorio

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

discount_amountMoneyData Obligatorio

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

Campos · discount_amount

Modelo completo: MoneyData

amountCadena de textoObligatorio

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

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
discountsLista <OrderDiscountData > Obligatorio

Descuentos

Campos · discounts

OrderDiscountData

Modelo completo: OrderDiscountData

idCadena de textoObligatorio

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

invoiceInvoiceData nullObligatorio

Información de la factura.

Campos · invoice

InvoiceData

Modelo completo: InvoiceData

null

invoice_requestedBooleanoObligatorio

Indica si se solicitó una factura.

lifecycle_stateOrderLifecycleState Obligatorio

Estado del ciclo de vida del recurso.

linesLista <OrderLineData > Obligatorio

Datos de las líneas de pedido conservados al registrarlo.

Campos · lines

OrderLineData

Modelo completo: OrderLineData

localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

paymentPaymentData Obligatorio

Detalles del pago registrados en el pedido.

Campos · payment

Modelo completo: PaymentData

amountMoneyData Obligatorio

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

environmentCadena de textoObligatorio

Información del entorno asociada al registro.

Restricciones
enum
["live", "sandbox"]
method_codeCadena de texto nullObligatorio

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

method_nameCadena de texto nullObligatorio

Nombre del método de entrega o pago.

paid_atCadena de texto nullObligatorio

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

Cadena de texto:format: "date-time"
statusOrderPaymentStatus Obligatorio

Estado admitido por esta operación concreta.

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"
versionNúmero enteroObligatorio

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

pickup_pointPickupPointData nullObligatorio

Punto de retiro

Campos · pickup_point

PickupPointData

Modelo completo: PickupPointData

null

prices_include_taxBooleanoObligatorio

Indica si los precios de la lista incluyen impuestos.

shipping_addressAddressData nullObligatorio

Dirección de entrega.

Campos · shipping_address

AddressData

Modelo completo: AddressData

null

shipping_discount_amountMoneyData Obligatorio

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

Campos · shipping_discount_amount

Modelo completo: MoneyData

amountCadena de textoObligatorio

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

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
statusOrderStatusData Obligatorio

Estado admitido por esta operación concreta.

Campos · status

Modelo completo: OrderStatusData

idCadena de textoObligatorio

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

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"
versionNúmero enteroObligatorio

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

subtotalMoneyData Obligatorio

Importe anterior a los componentes adicionales indicados en la respuesta.

Campos · subtotal

Modelo completo: MoneyData

amountCadena de textoObligatorio

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

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
taxMoneyData Obligatorio

Información fiscal.

Campos · tax

Modelo completo: MoneyData

amountCadena de textoObligatorio

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

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obligatorio

Grupos fiscales · source + tax_rate; unallocated_tax.

Campos · tax_breakdown

Modelo completo: OrderTaxBreakdownData

groupsLista <OrderTaxGroupData > Obligatorio

Grupos fiscales · source + tax_rate; Desconocido: null; cero conocido: 0.

unallocated_taxMoneyData Obligatorio

Impuesto sin asignar = order.tax − Σ groups.tax; ±.

tax_country_codeCadena de texto nullObligatorio

País fiscal · Datos guardados del pedido · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatorio

Importe total.

Campos · total

Modelo completo: MoneyData

amountCadena de textoObligatorio

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

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
totalsOrderTotalsData Obligatorio

Totales · net / tax / gross; Antes de descuentos / Después de descuentos.

Campos · totals

Modelo completo: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatorio

Pedido · Antes de descuentos · net / tax / gross.

discountsOrderAmountBreakdownData Obligatorio

Descuentos

orderOrderAmountBreakdownData Obligatorio

Pedido · Después de descuentos · net / tax / gross.

product_discountsOrderAmountBreakdownData Obligatorio

Productos · Descuentos · net / tax / gross.

productsOrderAmountBreakdownData Obligatorio

Productos · Después de descuentos · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obligatorio

Productos · Antes de descuentos · net / tax / gross.

shippingOrderAmountBreakdownData Obligatorio

Envío · Después de descuentos · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obligatorio

Envío · Antes de descuentos · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obligatorio

Envío · Descuentos · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Campos · meta

ContextPageMeta

Modelo completo: ContextPageMeta

localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

market_codeCadena de textoObligatorio

Código del mercado devuelto por el endpoint de contexto.

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

paginationPagination Obligatorio

Metadatos de la paginación por cursor.

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

ContextMeta

Modelo completo: ContextMeta

localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

market_codeCadena de textoObligatorio

Código del mercado devuelto por el endpoint de contexto.

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

PageMeta

Modelo completo: PageMeta

paginationPagination Obligatorio

Metadatos de la paginación por cursor.

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

RequestMeta

Modelo completo: RequestMeta

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100
Ejemplo de respuesta

Estado HTTP

200
Respuesta correcta Esquema
400
Solicitud no válida
401
Autenticación necesaria
403
Permiso denegado
404
Recurso no encontrado
409
Conflicto de versión
422
Error de validación
429
Límite de solicitudes excedido
Otros estados HTTP (7)
405
Método no permitido
413
Solicitud demasiado grande
415
Formato no compatible
500
Error del servidor
502
Error de la puerta de enlace API
503
Servicio no disponible
504
Tiempo de espera agotado

Catálogo de errores: ErrorResponse

Cabeceras

401

WWW-AuthenticateCadena de textoOpcional

Esquema de autenticación exigido por el servidor.

405

AllowCadena de textoOpcional

Métodos HTTP admitidos por este recurso.

429, 503

Retry-AfterNúmero enteroOpcional

Espera mínima antes de reintentar, en segundos.

minimum: 0

Catálogo de errores · Más información