Set Action

post

https://api-test.cargodocs.com/v3/exchange/sets/action

This endpoint allows the Partner user to action an eSet, i.e., return, transfer, present, etc. and trigger the Verified by CargoDocs page, to complete the action.

Body Params

customerId

string

Customer ID performing the SET ACTION process

employeeId

string

Employee within the Customer performing the Action

setId

string

The shipment or set id against which the action is being taken

actionName

string

enum

The available Actions

endorseType

string

enum

Type of endorsement applied over the Shipment

Allowed:

titleHolderId

string

Current title holder Id.

presentToPartyId

string

ID of the the party presenting the shipment for Action

financeType

string

enum

Finance type deduced from the available essDocs.

Allowed:

financeReference

string

Custom finance reference against the shipment

signatureId

string

Digital signature added along with the Action if required

Responses

400

Bad Request

401

Unauthorized

403

Forbidden access denied config issue

500

Internal Server Error

503

Service Unavailable

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200parcels response

defaultunexpected error