POST `/api-client/sales/orders/{id}/cancel`

apiSalesPostOrders_id_cancel · Sales

Tenant-scoped sales with fresh USER RBAC or API_CLIENT scopes and PUBLIC_API entitlement. Customers require customers.read/write. Orders require sales.read; draft writes require sales.create (machine sales.write) plus pricing.read. Confirmation adds inventory.adjust (machine inventory.write), refreshes current prices, freezes snapshots and reserves all stock/selected unit UUIDs. Completion requires sales.create+inventory.adjust (machine sales.write+inventory.write) and atomically consumes reservations and appends SALE movements; serialized units become SOLD without custody. Cancellation requires sales.cancel+inventory.adjust (machine sales.write+inventory.write) and releases reservations without reversing physical movements. State DRAFT→CONFIRMED→COMPLETED or cancellation before completion; expectedVersion mandatory. Single legal entity, warehouse and price-list currency per order; at most100 distinct lines and100 serial units. Decimal quantities/prices scale6, unrounded commercial totals scale12. All writes require Idempotency-Key; replay is denied after permission/scope/entitlement revocation. Machine pricing accepts public lists and published active variants. No anonymous access, purchase costs/margins, serial identities, payment, tax, invoice, return or UI in the Sales endpoints; cash checkout composes delivery through POS.

Autenticación: PlatformApiKey · http bearer
required-scopes: purchases.write

Ejemplo

Los valores entre <> y {} son marcadores: sustitúyelos por los tuyos antes de ejecutarlo.

curl --request POST \
  --url 'https://api.marky.ec/v1/api-client/sales/orders/{id}/cancel' \
  --header 'Authorization: Bearer <PlatformApiKey>' \
  --header 'Idempotency-Key: <Idempotency-Key>' \
  --header 'Content-Type: application/json' \
  --data @body.json

Parámetros

Nombre	En	Tipo	Descripción
`id`obligatorio	path	`stringformato uuidpatrón ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`
`Idempotency-Key`obligatorio	header	`stringformato uuid`	UUIDv4/v7; replay24h under fresh authorization, input fingerprint bound to aggregate ID.

Cuerpo (obligatorio)

application/json

SalesVersionInput

objectsin otras propiedades

expectedVersionobligatorio
integermín. 1máx. 2147483646

Respuestas

200 Success

Cache-Controlvalor fijo "no-store"

application/json

SalesOrderReceipt

objectsin otras propiedades

idobligatorio
stringformato uuidpatrón ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
statusobligatorio
stringuno de "DRAFT", "CONFIRMED", "COMPLETED", "CANCELLED"
versionobligatorio
integermín. 1máx. 2147483646
createdAtobligatorio
stringformato date-time
updatedAtobligatorio
stringformato date-time

400 Invalid request

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

401 Missing or invalid access token

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

403 Identity, membership or permission denied

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

404 Unknown resource

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

409 Duplicate permanent identity/IMEI, stale unit version, reserved/illegal unit state, custody/legal entity constraint or idempotency conflict.

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

413 Payload too large

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

429 Per-minute rate or monthly quota exceeded; authenticated API clients require PUBLIC_API entitlement.

Retry-Afterintegermín. 1 Seconds before retrying; quota reset is UTC next month.

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

500 Internal failure

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.

503 Auth/database/governance unavailable; no memory fallback for Redis.

application/problem+json

ProblemDetails

objectsin otras propiedades

typeobligatorio
valor fijo "about:blank"
statusobligatorio
integer
codeobligatorio
string
titleobligatorio
string
detailobligatorio
string
requestIdobligatorio
stringformato uuid
errors
arrayelementos máx. 200
Where each problem is, for the codes that can say it: a JSON pointer into the request or the record (`/items/0/devices/1/imei1`) and the reason. A line of a serialized article that is short of units also says how many it bills and how many are identified. Never a value typed by the user, and never an identifier of a unit.
Cada elemento
objectsin otras propiedades
- pointerobligatorio
  string
- codeobligatorio
  string
- required
  integermín. 0máx. 1000
  For a line short of units (UNITS_DIFFER_FROM_QUANTITY, RECEIPT_REQUIRED, DELIVERY_REQUIRED): how many units the line bills.
- identified
  integermín. 0máx. 1000
  For the same line: how many units are identified and linked to it. Given to every reader of the document; no IMEI or serial number is.