m2pfintech
API LibraryInventory Management

Transfer Kits Between Branches

Transfers card kits from one branch to another. This is used for inventory management when physical card kits need to be redistributed between branch locations. The API accepts a list of kit numbers and moves them from the source branch (fromBranch) to the destination branch (toBranch). Returns the count of successfully transferred kits and any failures.

POST
/inventory/kitsTransfer

Authorization

tenantAuth
tenant<token>

The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.

In: header

Header Parameters

tenant*string

The DCMS client or tenant name for multi-tenant isolation.

Request Body

application/json

fromBranch*string

Source branch identifier from which kits are being transferred.

toBranch*string

Destination branch identifier to which kits are being transferred.

kitNo*array<string>

List of kit numbers to transfer.

creator?string

Identifier of the user initiating the transfer.

chnager?string

Identifier of the user approving the change.

approver?string

Identifier of the user approving the transfer.

Response Body

application/json

application/json

curl -X POST "https://api.dcms.example.com/v1/inventory/kitsTransfer" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "fromBranch": "BRANCH001",    "toBranch": "BRANCH002",    "kitNo": [      "KIT12345678",      "KIT87654321"    ],    "creator": "Aks",    "chnager": "sja",    "approver": "ya"  }'
{
  "result": {
    "successCount": 2,
    "failedCount": 0,
    "failedKitNo": []
  },
  "exception": null,
  "pagination": null
}
{
  "result": {
    "successCount": 0,
    "failedCount": 2,
    "failedKitNo": [
      "KIT12345678",
      "KIT87654321"
    ]
  },
  "exception": {
    "errorCode": "INV001",
    "shortMessage": "Kit transfer failed",
    "detailMessage": "One or more kits could not be transferred",
    "httpStatus": "BAD_REQUEST",
    "fieldError": [
      "Invalid fromBranch"
    ],
    "languageCode": "en"
  },
  "pagination": null
}

Get Kit Summary POST

Retrieves a paginated kit list or report with various filter options. Supports filtering by branchId, cardOrderId, productId, cardType, embossType, and deliveryStatus. Returns kit details including card numbers, statuses, entity associations, and embedded metadata. The branchId field is required as a mandatory filter.

Update Delivery Status POST

Updates the delivery status for one or more card kits. Accepts a list of delivery status groups, each containing a delivery status value and a list of kit numbers to update. Returns individual success or failure results for each kit number. Common delivery statuses include DELIVERED, BANK, IN_TRANSIT, and RETURNED.