How to: Manage Ledger

For information about prerequisites, see Integrate with Dispatch.

Apply CustodyIn Scan

To apply CustodyIn Scan, call the Apply CustodyIn Scan endpoint and pass the following required members in the request body:

Member	Description	Remarks
`dispatchId`	ID of the Dispatch.	string minLength: 1 maxLength: 64
`custodyEntity`	Type of Entity.	string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

{
  "dispatchId": "string",
  "custodyEntity": "CONTAINER",
  "custodyEntityId": "string",
  "custodyLocationId": "string",
  "custodyEntityAmount": 0,
  "jobId": "string",
  "_event_meta": {}
}

To apply CustodyIn Scan in Batch, call the Apply CustodyIn Scan in Batch endpoint and pass the following required members in the request body:

Member	Description	Remarks
`dispatchId`	ID of the Dispatch.	string minLength: 1 maxLength: 64
`data` > `custodyEntity`	Type of Entity.	string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

{
  "dispatchId": "string",
  "data": [
    {
      "custodyEntity": "CONTAINER",
      "custodyEntityId": "string",
      "custodyLocationId": "string",
      "custodyEntityAmount": 0,
      "jobId": "string"
    }
  ],
  "_event_meta": {}
}

Apply CustodyOut Scan

To apply CustodyOut Scan, call the Apply CustodyOut Scan endpoint and pass the following required members in the request body:

Member	Description	Remarks
`dispatchId`	ID of the Dispatch.	string minLength: 1 maxLength: 64
`custodyEntity`	Type of Entity.	string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

{
  "dispatchId": "string",
  "custodyEntity": "CONTAINER",
  "custodyEntityId": "string",
  "custodyLocationId": "string",
  "custodyEntityAmount": 0,
  "jobId": "string",
  "_event_meta": {}
}

To apply CustodyOut Scan in Batch, call the Apply CustodyOut Scan in Batch endpoint and pass the following required members in the request body:

Member	Description	Remarks
`dispatchId`	ID of the Dispatch.	string minLength: 1 maxLength: 64
`data` > `custodyEntity`	Type of Entity.	string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

{
  "dispatchId": "string",
  "data": [
    {
      "custodyEntity": "CONTAINER",
      "custodyEntityId": "string",
      "custodyLocationId": "string",
      "custodyEntityAmount": 0,
      "jobId": "string"
    }
  ],
  "_event_meta": {}
}