iotoms Docs

Confirm a stock reservation

PATCH
/api/v1/inventory/reservations/{id}/confirm

Confirms an active or held reservation once payment is authorised, so it no longer expires.

How to use it

  1. Take an ACTIVE or CHECKOUT_HOLD reservation id.
  2. Call confirm once payment is authorised.
  3. The status becomes CONFIRMED with the time recorded; the stock stays reserved and no longer expires.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The stock reservation.

Example Request
curl -X PATCH 'https://beta.iotoms.com/api/v1/inventory/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08/confirm'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "itemId": "string",    "itemName": "string",    "quantity": 0,    "reservationType": "CART",    "referenceId": "8502eb05-558d-4480-8511-c1011710b340",    "customerId": "string",    "status": "ACTIVE",    "expiresAt": "2019-08-24T14:15:22Z",    "confirmedAt": "2019-08-24T14:15:22Z",    "releasedAt": "2019-08-24T14:15:22Z",    "releaseReason": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}