Skip to navigation

Buscar una orden por su referencia externa

Busca exactamente la referencia, distinguiendo mayúsculas y minúsculas, dentro de la cuenta y ambiente de la llave. Devuelve la orden completa si existe; si el borrador fue eliminado, solo su id, status: deleted y external_reference. La referencia se conserva sin vencimiento.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Headers

X-ACCOUNT-IDstringOptional

ID de una cuenta hija conectada. Ejecuta el request dentro de esa cuenta, como Stripe-Account en Stripe Connect. La plataforma puede acceder a todos los recursos API que pertenecen a la hija, sin filtrar por creador. Solo aplica a hijas directas: si la cuenta no está conectada a la tuya, el request responde 404 con code: connected_account_not_found.

Con una llave de organización este header nombra la cuenta miembro sobre la que quieres operar; si no pertenece a la organización, el request responde 404 con code: organization_account_not_found. En una lectura puedes omitirlo para abarcar todas las cuentas de la organización.

Query parameters

external_referencestringRequired1-255 characters
Referencia del ERP enviada al crear la orden

Response

Orden original o constancia de su eliminación

PurchaseOrderobject

Una venta a crédito a otro negocio: quién debe, cuánto y para cuándo. El comprador la paga con su link (checkout_url) o fuera de Recurrente, y ese pago se registra con POST /purchase_orders/{purchase_order_id}/payments.

OR
DeletedPurchaseOrderReferenceobject

Errors

403
Forbidden Error
404
Not Found Error