Inventory

Campaign Inventory Management APIs

Facilitates the maintenance and management of inventories.

PreviousIndividual NextLand

Last updated 1 year ago

Was this helpful?

Create a Inventory Log.

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

post

/log/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

inventoryLogobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inventory/log/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

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

Inventory Log created successfully.

Update An Inventory Log.

Update An Inventory Log, Ok response is returned.

post

/log/v1/_update

Body

requestInfoobject

inventoryLogobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inventory/log/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

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

Updated Inventory Log successfully.

Search Inventory Log.

Search Inventory Log Ok response is returned.

post

/log/v1/_search

Body

requestInfoobject

inventorySearchCriteriaobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inventory/log/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

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

Fetched Search InventoryLogs.

Create a Reconciliation Log.

Creates Reconciliation Log On successful Reconciliation Ok response is returned.

post

/reconciliation/v1/_create

Body

requestInfoobject

reconciliationLogobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inventory/reconciliation/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "quantityUnit": "BALE"
    },
    "comment": "RECEIVED",
    "transactionReason": "100 Entry Missing",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Reconciliation Log created successfully.

Search reconciliation Logs.

Search reconciliation Logs Ok response is returned.

post

/reconciliation/v1/_search

Body

requestInfoobject

reconciliationSearchCriteriaobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inventory/reconciliation/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "quantityUnit": "BALE"
      },
      "comment": "RECEIVED",
      "transactionReason": "100 Entry Missing",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Fetched Search reconciliation Logs.