Ver una promoción

GET/api/v1/price-lists/get-promotion

Permiso

price-lists.view

Empresa

Opera sobre la empresa activa

Tipo

Lectura: no cambia nada

Respuesta

JSON

Encabezados

• Cookietextorequerido

  La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.

• X-Expected-Companyuuidrequerido

  La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

• promotionIduuidrequerido

Respuesta

200 con este JSON.

• iduuidrequerido
• priceListIduuidrequerido
• priceListNametextorequerido
• nametextorequerido
• scopeopciónrequerido

  Valores: item items family list

• familyobjetorequeridoadmite null
  Campos (2)

  • iduuidrequerido
  • pathtextorequerido
• itemslista de objetorequerido
  Campos de cada elemento (7)

  • itemIduuidrequerido
  • codetextorequerido
  • nametextorequerido
  • unitNametextorequerido
  • levelopciónrequeridoadmite null

    Valores: primary_box secondary_box pallet

  • levelUnitsnúmerorequerido
  • countssí o norequerido
• measureopciónrequerido

  Valores: unit package

• benefitopciónrequerido

  Valores: percent price

• validFromfecharequerido
• validTofecharequeridoadmite null
• statusopciónrequerido

  Valores: draft active inactive

• statusReasoncualquierarequerido
• validityopciónrequerido

  Valores: current scheduled expired

• versionenterorequerido

  mínimo 1

• tierslista de objetorequerido
  Campos de cada elemento (4)

  • fromQuantitynúmerorequerido
  • discountPercentcualquierarequerido
  • freeQuantitycualquierarequerido
  • priceslista de objetorequerido
    Campos de cada elemento (2)

    • itemIduuidrequerido
    • unitPricetextorequerido

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

401	Falta la credencial o venció.
403	La credencial no tiene el permiso price-lists.view.
409	La empresa activa no es la de X-Expected-Company.
422	Datos inválidos o una regla de negocio rota, con el detalle por campo.
503	Sistema ocupado: reintentá después de Retry-After segundos.

La lista completa está en Errores.

curl

curl "$ERP_URL/api/v1/price-lists/get-promotion?promotionId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

TypeScript

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/price-lists/get-promotion?promotionId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

Respuesta 200

{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "priceListId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "priceListName": "texto",
  "name": "texto",
  "scope": "item",
  "family": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "path": "texto"
  },
  "items": [
    {
      "itemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "code": "texto",
      "name": "texto",
      "unitName": "texto",
      "level": "primary_box",
      "levelUnits": 100,
      "counts": false
    }
  ],
  "measure": "unit",
  "benefit": "percent",
  "validFrom": "2026-10-23",
  "validTo": "2026-10-23",
  "status": "draft",
  "statusReason": null,
  "validity": "current",
  "version": 1,
  "tiers": [
    {
      "fromQuantity": 100,
      "discountPercent": null,
      "freeQuantity": null,
      "prices": [
        {
          "itemId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
          "unitPrice": "texto"
        }
      ]
    }
  ]
}