iotoms Docs

List reservations for a reference

GET
/api/v1/inventory/reservations

Returns all stock reservations attached to a referenceId (such as a cart or order) of the given reservationType (CART or ORDER).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

referenceId*string

Identifier of the cart or order the reservations were made for. Required.

Formatuuid
reservationType*string

Required. CART or ORDER, matching what referenceId is.

Value in"CART""ORDER"

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?array<>|

The reservations attached to the reference.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/reservations?referenceId=497f6eca-6276-4993-bfeb-53cbbbba6f08&reservationType=CART'
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"    }  ]}