Inventory

Campaign Inventory Management APIs

Facilitates the maintenance and management of inventories.

Create a Inventory Log.

Creates Inventory Log On successful Inventory Log Ok response is returned.

POST/inventory/log/v1/_create

Body

application/json

Details of the InventoryLogs and RequestInfo meta data.

inventoryLog*InventoryLogRequest (object)

Response

200400500

Inventory Log created successfully.

Body

*/*

inventoryLog*all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/inventory/log/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inventoryLog": {}
    }),
});
const data = await response.json();

Response

200

{
  "inventoryLog": {
    "inventoryLogId": "UUID",
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    }
  }
}

Update An Inventory Log.

Update An Inventory Log, Ok response is returned.

POST/inventory/log/v1/_update

Body

application/json

Details of the InventoryLog and RequestInfo meta data.

inventoryLogInventoryLogUpdateRequest (object)

Response

200400500

Updated Inventory Log successfully.

Body

*/*

inventoryLog*all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/inventory/log/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "inventoryLog": {
    "inventoryLogId": "UUID",
    "tenantId": "text",
    "campaignId": "CAMP-ID",
    "transactionPartyId": "WARE-HOUSE-2",
    "transactionPartyType": "RECEIVED",
    "transactionReason": "RETURNED REASON",
    "transactionDate": 1663218161,
    "warehouseId": "WARE-HOUSE-3",
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "INVENTORY",
      "version": 2,
      "fields": [
        {
          "key": "Vehicle Number",
          "value": "MH12AB1212"
        }
      ]
    }
  }
}

Search Inventory Log.

Search Inventory Log Ok response is returned.

POST/inventory/log/v1/_search

Body

application/json

Search Criteria for Inventory Logs and RequestInfo meta data.

inventorySearchCriteriaobject

Response

200400500

Fetched Search InventoryLogs.

Body

*/*

totalCountinteger

Example: 0

inventoryLogsarray of InventoryLogResponse (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/inventory/log/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "totalCount": 0,
  "inventoryLogs": [
    {
      "tenantId": "text",
      "inventoryLogId": "UUID",
      "campaignId": "CAMP-ID",
      "transactionPartyId": "WARE-HOUSE-2",
      "transactionPartyType": "RECEIVED",
      "transactionReason": "RETURNED REASON",
      "transactionDate": 1663218161,
      "warehouseId": "WARE-HOUSE-3",
      "resource": {
        "tenantId": "text",
        "resourceId": "ID-1",
        "resourceType": "BEDNET",
        "resourceName": "LLIN",
        "quantity": 100,
        "quantityUnit": "BALE"
      },
      "clientReferenceId": "GUID",
      "additionalFields": {
        "schema": "INVENTORY",
        "version": 2,
        "fields": [
          {
            "key": "Vehicle Number",
            "value": "MH12AB1212"
          }
        ]
      }
    }
  ]
}

Create a Reconciliation Log.

Creates Reconciliation Log On successful Reconciliation Ok response is returned.

POST/inventory/reconciliation/v1/_create

Body

application/json

Details of the Reconciliation Log and RequestInfo meta data.

reconciliationLog*ReconciliationRequest (object)

Response

200400500

Reconciliation Log created successfully.

Body

*/*

reconciliationLogReconciliationRequest (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/inventory/reconciliation/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reconciliationLog": {}
    }),
});
const data = await response.json();

Response

200

{
  "reconciliationLog": {
    "tenantId": "text",
    "warehouseId": "WARE-HOUSE-2",
    "campaignId": "CAMP-ID",
    "dateOfReconciliation": 1663218161,
    "clientReferenceId": "GUID",
    "calculatedCount": 200,
    "physicallyRecordedCount": 122,
    "resource": {
      "tenantId": "text",
      "resourceId": "ID-1",
      "resourceType": "BEDNET",
      "resourceName": "LLIN",
      "quantity": 100,
      "quantityUnit": "BALE"
    },
    "comment": "RECEIVED",
    "transactionReason": "100 Entry Missing"
  }
}

Search reconciliation Logs.

Search reconciliation Logs Ok response is returned.

POST/inventory/reconciliation/v1/_search

Body

application/json

Search Criteria for reconciliation and RequestInfo meta data.

reconciliationSearchCriteria*object

Response

200400500

Fetched Search reconciliation Logs.

Body

*/*

totalCountinteger

Example: 0

reconciliationLogsarray of all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/inventory/reconciliation/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reconciliationSearchCriteria": {}
    }),
});
const data = await response.json();

Response

200

{
  "totalCount": 0,
  "reconciliationLogs": [
    {
      "reconciliationId": "1212",
      "tenantId": "text",
      "warehouseId": "WARE-HOUSE-2",
      "campaignId": "CAMP-ID",
      "dateOfReconciliation": 1663218161,
      "clientReferenceId": "GUID",
      "calculatedCount": 200,
      "physicallyRecordedCount": 122,
      "resource": {
        "tenantId": "text",
        "resourceId": "ID-1",
        "resourceType": "BEDNET",
        "resourceName": "LLIN",
        "quantity": 100,
        "quantityUnit": "BALE"
      },
      "comment": "RECEIVED",
      "transactionReason": "100 Entry Missing"
    }
  ]
}