OS1 Services
...
Dispatch Service
Integrate with Dispatch

How to: Manage Ledger

5min

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:

JSON


To apply CustodyIn Scan in Batch, 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

data > custodyEntity

Type of Entity

string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

JSON


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:

JSON


To apply CustodyOut Scan in Batch, 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

data > custodyEntity

Type of Entity

string Enum: [ CONTAINER, CASH, DOCUMENT ]

The JSON request body should be similar to the following:

JSON