iotoms Docs

List stock transfers

GET
/api/v1/inventory/transfers

Returns stock transfers with their lines. Optionally filter by transferType, status, or locationId (matches either the source or destination location). Not paginated.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

transferType?string

Only return transfers of this type: VAN_LOADING, VAN_RETURN, STORE_RECEIVING, INTER_STORE, MFG_TO_WAREHOUSE or MANUAL.

Value in"VAN_LOADING""VAN_RETURN""STORE_RECEIVING""INTER_STORE""MFG_TO_WAREHOUSE""MANUAL"
status?string

Only return transfers in this status: DRAFT, IN_TRANSIT, PARTIAL, RECEIVED or CANCELLED.

Value in"DRAFT""CONFIRMED""IN_TRANSIT""RECEIVED""PARTIAL""CANCELLED"
locationId?string

Only return transfers leaving from or arriving at this stockroom. ID from List inventory locations.

Formatuuid

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?array<>|

Stock transfers matching the filters, each with its item lines. Not paginated.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/transfers'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "transferNumber": "string",      "transferType": "VAN_LOADING",      "fromLocationId": "178bb398-90d2-4fc3-a4a0-37fc0eed2806",      "fromLocationName": "string",      "toLocationId": "e81ad314-9cb9-45ae-9ad9-f1b5ebcc7aae",      "toLocationName": "string",      "status": "DRAFT",      "referenceId": "8502eb05-558d-4480-8511-c1011710b340",      "referenceType": "string",      "transferDate": "2019-08-24",      "expectedReceiptDate": "2019-08-24",      "confirmedBy": "string",      "confirmedAt": "2019-08-24T14:15:22Z",      "receivedBy": "string",      "receivedAt": "2019-08-24T14:15:22Z",      "notes": "string",      "items": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "itemId": "string",          "itemName": "string",          "requestedQty": 0,          "dispatchedQty": 0,          "receivedQty": 0,          "varianceQty": 0,          "unitCost": 0,          "notes": "string"        }      ],      "totalItems": 0,      "totalRequestedQty": 0,      "totalDispatchedQty": 0,      "totalReceivedQty": 0,      "totalVarianceQty": 0,      "createdAt": "2019-08-24T14:15:22Z"    }  ]}