Pedidos

Descartar un pedido

Descarta un pedido en borrador con un motivo. El pedido conserva su número.

POST/api/v1/sales-orders/discard

Permiso: sales-orders.create
Empresa: Opera sobre la empresa activa
Tipo: Escritura: pide Idempotency-Key
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.
Idempotency-Keytextorequerido
Una clave única por intento, de hasta 255 caracteres. Reintentar con la misma clave y los mismos datos devuelve el mismo resultado sin repetir la operación. Ver Idempotencia.

Cuerpo

JSON con Content-Type: application/json.

salesOrderIduuidrequerido
versionenterorequerido
mínimo 1
reasontextorequerido
de 1 a 500 caracteres

Respuesta

200 con este JSON.

iduuidrequerido
numbertextorequerido
statusopciónrequerido
Valores: draft confirmed closed discarded
documentDatefecharequerido
customerobjetorequerido
Campos (5)
- iduuidrequerido
- codeenterorequerido
- legalNametextorequerido
- documentTypetextorequerido
- taxIdtextorequerido
netTotaltextorequerido
invoicingProgressopciónrequeridoadmite null
Valores: not-invoiced partial invoiced
tracksDeliverysí o norequerido
deliveryProgressopciónrequeridoadmite null
Valores: not-delivered partial delivered
versionenterorequerido
mínimo 1
notescualquierarequerido
customerOrderReferencecualquierarequerido
paymentTermobjetorequeridoadmite null
Campos (3)
- iduuidrequerido
- nametextorequerido
- statusopciónrequerido
  Valores: active inactive
paymentPlanlista de objetorequeridoadmite null
Campos de cada elemento (2)
- percentnúmerorequerido
- dueDaysenterorequerido
paymentPlanTexttextorequerido
headerDiscountPercentnúmerorequerido
headerDiscountAmounttextorequerido
lineslista de objetorequerido
Campos de cada elemento (19)
- iduuidrequerido
- itemobjetorequerido
  Campos (8)
  - iduuidrequerido
  - codetextorequerido
  - nametextorequerido
  - statusopciónrequerido
    Valores: active inactive
  - isSoldsí o norequerido
  - unitCodetextorequerido
  - unitNametextorequerido
  - allowsDecimalssí o norequerido
- quantitynúmerorequerido
- lineKindopciónrequerido
  Valores: sale free
- unitPricecualquierarequerido
- priceSourceopciónrequeridoadmite null
  Valores: customer-price customer-list general-list promotion manual
- listPricecualquierarequerido
- promotionobjetorequeridoadmite null
  Campos (2)
  - iduuidrequerido
  - nametextorequerido
- proposedPricecualquierarequerido
- discountPercentnúmerorequerido
- netAmounttextorequerido
- vatRatecualquierarequerido
- invoicedQuantitynúmerorequerido
- heldQuantitynúmerorequerido
- pendingQuantitynúmerorequerido
- deliveredQuantitynúmerorequerido
- inDeliveryQuantitynúmerorequerido
- pendingDeliveryQuantitynúmerorequerido
- tracksStocksí o norequerido
totalsobjetorequerido
Campos (5)
- subtotaltextorequerido
- headerDiscounttextorequerido
- nettextorequerido
- vatlista de objetorequerido
  Campos de cada elemento (3)
  - ratenúmerorequerido
  - basetextorequerido
  - amounttextorequerido
- totaltextorequerido
createdAtfecha y horarequerido
createdByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
confirmedAtfecha y horarequeridoadmite null
confirmedByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
closedAtfecha y horarequeridoadmite null
closedByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
closeReasoncualquierarequerido
discardedAtfecha y horarequeridoadmite null
discardedByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
discardReasoncualquierarequerido

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 `sales-orders.create`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`409`	Otra persona cambió el registro desde que lo leíste (`record.stale`).
`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
TypeScript

curl -X POST "$ERP_URL/api/v1/sales-orders/discard" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "salesOrderId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "version": 1,
  "reason": "texto"
}'

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/sales-orders/discard`, {
  method: "POST",
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "salesOrderId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "version": 1,
    "reason": "texto"
  }),
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "number": "texto",
  "status": "draft",
  "documentDate": "2026-10-23",
  "customer": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "code": 1,
    "legalName": "texto",
    "documentType": "texto",
    "taxId": "texto"
  },
  "netTotal": "texto",
  "invoicingProgress": "not-invoiced",
  "tracksDelivery": false,
  "deliveryProgress": "not-delivered",
  "version": 1,
  "notes": null,
  "customerOrderReference": null,
  "paymentTerm": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "name": "texto",
    "status": "active"
  },
  "paymentPlan": [
    {
      "percent": 100,
      "dueDays": 1
    }
  ],
  "paymentPlanText": "texto",
  "headerDiscountPercent": 100,
  "headerDiscountAmount": "texto",
  "lines": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "item": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "code": "texto",
        "name": "texto",
        "status": "active",
        "isSold": false,
        "unitCode": "texto",
        "unitName": "texto",
        "allowsDecimals": false
      },
      "quantity": 100,
      "lineKind": "sale",
      "unitPrice": null,
      "priceSource": "customer-price",
      "listPrice": null,
      "promotion": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "name": "texto"
      },
      "proposedPrice": null,
      "discountPercent": 100,
      "netAmount": "texto",
      "vatRate": null,
      "invoicedQuantity": 100,
      "heldQuantity": 100,
      "pendingQuantity": 100,
      "deliveredQuantity": 100,
      "inDeliveryQuantity": 100,
      "pendingDeliveryQuantity": 100,
      "tracksStock": false
    }
  ],
  "totals": {
    "subtotal": "texto",
    "headerDiscount": "texto",
    "net": "texto",
    "vat": [
      {
        "rate": 100,
        "base": "texto",
        "amount": "texto"
      }
    ],
    "total": "texto"
  },
  "createdAt": "2026-10-23T14:30:00.000Z",
  "createdBy": {
    "id": "texto",
    "name": null
  },
  "confirmedAt": "2026-10-23T14:30:00.000Z",
  "confirmedBy": {
    "id": "texto",
    "name": null
  },
  "closedAt": "2026-10-23T14:30:00.000Z",
  "closedBy": {
    "id": "texto",
    "name": null
  },
  "closeReason": null,
  "discardedAt": "2026-10-23T14:30:00.000Z",
  "discardedBy": {
    "id": "texto",
    "name": null
  },
  "discardReason": null
}