Create an enterprise product inventory hold
curl --request POST \
--url https://api.simplepay.mx/v1/products/{id}/holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"items": [
{
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2
}
],
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2,
"hold_minutes": 60,
"customer": {},
"metadata": {}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
occurrence_id: '<string>',
tier_id: '<string>',
inventory_pool_id: '<string>',
inventory_unit_id: '<string>',
quantity: 2
}
],
occurrence_id: '<string>',
tier_id: '<string>',
inventory_pool_id: '<string>',
inventory_unit_id: '<string>',
quantity: 2,
hold_minutes: 60,
customer: {},
metadata: {}
})
};
fetch('https://api.simplepay.mx/v1/products/{id}/holds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/products/{id}/holds"
payload = {
"items": [
{
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2
}
],
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2,
"hold_minutes": 60,
"customer": {},
"metadata": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "<unknown>",
"id": "<string>",
"product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookable": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"quantity": 2,
"expires_at": "2023-11-07T05:31:56Z",
"items": [
{}
]
}Create an enterprise product inventory hold
Referencia detallada para POST /v1/products//holds.
POST
https://api.simplepay.mx
/
v1
/
products
/
{id}
/
holds
Create an enterprise product inventory hold
curl --request POST \
--url https://api.simplepay.mx/v1/products/{id}/holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"items": [
{
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2
}
],
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2,
"hold_minutes": 60,
"customer": {},
"metadata": {}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
occurrence_id: '<string>',
tier_id: '<string>',
inventory_pool_id: '<string>',
inventory_unit_id: '<string>',
quantity: 2
}
],
occurrence_id: '<string>',
tier_id: '<string>',
inventory_pool_id: '<string>',
inventory_unit_id: '<string>',
quantity: 2,
hold_minutes: 60,
customer: {},
metadata: {}
})
};
fetch('https://api.simplepay.mx/v1/products/{id}/holds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.simplepay.mx/v1/products/{id}/holds"
payload = {
"items": [
{
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2
}
],
"occurrence_id": "<string>",
"tier_id": "<string>",
"inventory_pool_id": "<string>",
"inventory_unit_id": "<string>",
"quantity": 2,
"hold_minutes": 60,
"customer": {},
"metadata": {}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "<unknown>",
"id": "<string>",
"product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bookable": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"quantity": 2,
"expires_at": "2023-11-07T05:31:56Z",
"items": [
{}
]
}Uso
Usalo para administrar productos del tenant, ofertas, disponibilidad o inventario empresarial asociado al catalogo SimplePay.Antes de llamar
| Tema | Detalle |
|---|---|
| Metodo | POST |
| Ruta | /v1/products/{id}/holds |
| Auth | Bearer API key del ambiente correcto. |
| Scope | bookings:write |
| Idempotencia | Recomendada para cualquier retry. Usa una key deterministica por operacion de negocio. |
| Guia relacionada | API Reference overview |
Patron recomendado
- Ejecuta este endpoint desde backend o job seguro, nunca desde frontend con API keys.
- Manda
Idempotency-Keycuando el endpoint cree, convierta, reprograme, cancele, capture o reembolse estado. - Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.
Ejemplo minimo
terminal
curl -sS -X POST "https://api.simplepay.mx/v1/products/id_123/holds" \
-H "Authorization: Bearer $SIMPLEPAY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: create-product-inventory-hold_v1" \
-d '{ ... }'
Errores a manejar
400indica payload, parametros o estado invalido.401o403indican API key, ambiente o scopes incorrectos.409suele indicar conflicto de estado, duplicado o idempotencia incompatible.404significa que el recurso no existe para ese tenant o ambiente.429y5xxse pueden reintentar con backoff; en writes conserva la misma idempotency key.
Contrato OpenAPI
El playground, parametros, body y respuestas de abajo salen de/openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required string length:
8 - 255Path Parameters
Body
application/json
Required range:
x >= 1Required range:
1 <= x <= 120Response
201 - application/json
Enterprise inventory hold created
Last modified on June 21, 2026
⌘I