Órdenes de compra
Lo que la tienda pidió al proveedor: líneas con cantidad pedida, confirmada y recibida, precio y fecha de entrega prometida.
Órdenes de compra
Objetos
PurchaseOrder
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
versionintegerobligatorioVersión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.
numberstring o nullobligatorioNúmero de la orden; null en una orden creada antes de la numeración.
statusstringobligatoriodraft: borrador, no enviada al proveedor; sent: emitida, se espera la entrega; partial: recibida en parte; received: recibida por completo; closed: cerrada por la tienda, recibida completa o con faltante (closed_short); cancelled: cancelada.
- Valores:
draftsentpartialreceivedclosedcancelled
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
location_idintegerobligatorioLocal donde se espera la entrega (/v1/locations).
legal_entity_idinteger o nullobligatorioRazón social compradora de la tienda (/v1/legal-entities); null en una orden creada antes de que la tienda tuviera razones sociales.
currencystringobligatorioMoneda de la orden, ISO 4217: en ella van los precios de las líneas y los totales.
prices_include_taxbooleanobligatoriotrue: los precios de las líneas incluyen impuestos; false: no los incluyen.
ordered_totalintegerobligatorioValor de lo pedido vigente; en una línea cerrada, de lo recibido.
received_totalintegerobligatorioValor de lo recibido contra la orden.
expected_onstring (date) o nullobligatorioCuándo la tienda espera la entrega, YYYY-MM-DD; null si no se fijó.
next_delivery_onstring (date) o nullobligatorioPróxima entrega esperada según las fechas que prometió el proveedor, YYYY-MM-DD; null si no se espera nada.
placed_atstring (date-time) o nullobligatorioCuándo la orden se envió por primera vez al proveedor; null en un borrador y en una orden cancelada antes de enviarse.
closed_shortbooleanobligatoriotrue: la orden se cerró con faltante y el resto ya no se espera.
supplier_responsestring o nullobligatorioRespuesta del proveedor: awaiting: pendiente; confirmed: confirmó tal cual; changed: confirmó con cambios (confirmed_quantity y promised_on de las líneas); declined: rechazó; null: no se siguen las respuestas.
- Valores:
awaitingconfirmedchangeddeclinednull
revisionintegerobligatorioRevisión de las condiciones que ve el proveedor: crece con cada cambio de una orden emitida.
notestring o nullobligatorioNota del personal; null si no hay.
linesarray de objectobligatorioLíneas de la orden en su orden.
Campos · 12
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
variant_idintegerobligatorioID de la variante del producto (/v1/variants).
unitstring o nullobligatorioUnidad base de las cantidades de la línea: pcs, unidades; g, gramos; ml, mililitros.
ordered_quantitystring o nullobligatorioCantidad pedida, texto decimal en la unidad base.
confirmed_quantitystring o nullobligatorioCantidad que confirmó el proveedor; null si no respondió por la línea.
received_quantitystring o nullobligatorioCantidad recibida contra la línea.
unit_costinteger o nullobligatorioPrecio en la moneda de la orden por cost_per_quantity; null si no hay precio.
cost_per_quantitystring o nullobligatorioCantidad en la unidad base a la que corresponde el precio: "1000" en un producto por peso es por kilo.
ordered_amountinteger o nullobligatorioValor de la cantidad vigente de la línea; null sin precio. La suma de las líneas da ordered_total.
received_amountinteger o nullobligatorioValor de lo recibido por la línea; null sin precio. La suma de las líneas da received_total.
promised_onstring (date) o nullobligatorioFecha de entrega prometida por el proveedor, YYYY-MM-DD; null si no la prometió y se espera para expected_on.
closed_atstring (date-time) o nullobligatorioCuándo se cerró la línea y se dejó de esperar el resto; null en una línea abierta.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Órdenes de compra: lo pedido, lo confirmado por el proveedor y lo recibido por línea
get/purchase-orders
Scope: procurement:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
supplier_idintegerSolo documentos de este proveedor.
- Mínimo:
- 1
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/purchase-orders" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Crear un borrador de orden de compra
post/purchase-orders
Scope: procurement:write
Parámetros
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
supplier_idintegerobligatorioID del proveedor (/v1/suppliers).
location_idintegerobligatorioLocal donde se espera la entrega (/v1/locations).
legal_entity_idinteger o nullRazón social compradora de la tienda (/v1/legal-entities); null en una orden creada antes de que la tienda tuviera razones sociales.
currencystringobligatorioMoneda de la orden, ISO 4217: en ella van los precios de las líneas y los totales.
- Valores:
ARSUSDBRLCLPCOPMXNPENRUB
prices_include_taxbooleantrue: los precios de las líneas incluyen impuestos; false: no los incluyen.
expected_onstring (date) o nullCuándo la tienda espera la entrega, YYYY-MM-DD; null si no se fijó.
notestring o nullNota del personal; null si no hay.
- Largo máximo:
- 2000
linesarray de objectobligatorioLíneas de la orden en su orden.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 500
- Sin repetidos
Campos · 4
variant_idintegerobligatorioID de la variante del producto (/v1/variants).
ordered_quantitystringobligatorioCantidad pedida, texto decimal en la unidad base.
- Largo máximo:
- 32
unit_costinteger o nullPrecio en la moneda de la orden por cost_per_quantity; null si no hay precio.
- Mínimo:
- 0
- Máximo:
- 10000000000
cost_per_quantitystringCantidad en la unidad base a la que corresponde el precio: "1000" en un producto por peso es por kilo.
- Largo máximo:
- 32
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/purchase-orders" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "ARS",
"prices_include_tax": true,
"expected_on": "2026-01-15",
"note": "string",
"lines": [
{
"variant_id": 0,
"ordered_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string"
}
]
}{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Orden de compra
get/purchase-orders/{purchase_order}
Scope: procurement:read
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/purchase-orders/{purchase_order}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Cambiar una orden de compra: el borrador entero; de la colocada, las líneas, la fecha y la nota con revisión
patch/purchase-orders/{purchase_order}
Scope: procurement:write
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
purchase_order_refusedLa orden de compra no acepta este comando - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X PATCH "https://api.saleya.app/v1/purchase-orders/{purchase_order}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Borrar un borrador de orden de compra
delete/purchase-orders/{purchase_order}
Scope: procurement:write
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Query
consentobjectConsentimientos a las consecuencias del cambio, por tipo: consent[<consent_kind>]=<consent_token> de una respuesta 409 consent_required. Conservá los consentimientos ya dados cuando se pide el tipo siguiente.
Campos · 1
purchase_order_follow_upstringEl borrador es un pedido complementario de la decisión «comprar a otro» en la respuesta del proveedor a otra orden: borrarlo retira esa decisión y la diferencia de la orden de origen vuelve a esperar una decisión. source_orders cuenta las órdenes de origen afectadas.
- Largo mínimo:
- 64
- Largo máximo:
- 64
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
204Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
Sin cuerpo
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
consent_requiredHace falta consentir las consecuencias - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
in_use_conflictRegistro en uso - 409
purchase_order_refusedLa orden de compra no acepta este comando - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X DELETE "https://api.saleya.app/v1/purchase-orders/{purchase_order}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'Marcar el borrador como colocado con el proveedor
post/purchase-orders/{purchase_order}/place
Scope: procurement:write
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
purchase_order_refusedLa orden de compra no acepta este comando - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/purchase-orders/{purchase_order}/place" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Cancelar una orden de compra colocada
post/purchase-orders/{purchase_order}/cancel
Scope: procurement:write
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
purchase_order_refusedLa orden de compra no acepta este comando - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/purchase-orders/{purchase_order}/cancel" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}Cerrar una orden de compra recibida
post/purchase-orders/{purchase_order}/close
Scope: procurement:write
Parámetros
Ruta
purchase_orderintegerobligatorioID de la orden de compra.
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve PurchaseOrder
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 403
capability_disabledRecurso no disponible para esta tienda - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
purchase_order_refusedLa orden de compra no acepta este comando - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/purchase-orders/{purchase_order}/close" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'{
"id": 0,
"version": 0,
"number": "string",
"status": "draft",
"supplier_id": 0,
"location_id": 0,
"legal_entity_id": 0,
"currency": "string",
"prices_include_tax": true,
"ordered_total": 0,
"received_total": 0,
"expected_on": "2026-01-15",
"next_delivery_on": "2026-01-15",
"placed_at": "2026-01-15T12:00:00Z",
"closed_short": true,
"supplier_response": "awaiting",
"revision": 0,
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"unit": "string",
"ordered_quantity": "string",
"confirmed_quantity": "string",
"received_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"ordered_amount": 0,
"received_amount": 0,
"promised_on": "2026-01-15",
"closed_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}