logo
API docs by Redocly

Logivity - API (1.2.3)

Download OpenAPI specification:

For more details, visit the Logivity Help Center

Authentication

This is used to get the bearer token. Token is set as varibale authorization and used in the subsequent calls

Create Auth Token (GetBearerToken)

Create Auth Token (GetBearerToken)

Request Body schema: application/json
password
string
username
string

Responses

Request samples

Content type
application/json
{
  • "password": "{{auth-password}}",
  • "username": "{{auth-username}}"
}

Response samples

Content type
application/json
{
  • "access_token": "accesstokenjwtstring",
  • "token_type": "Bearer",
  • "expires_in": 3600
}

Notifications

This is a collection with examples to create a new subscription to RestProxy events and how to manage them

ListSubscriptionbyId

ListSubscriptionbyId

Authorizations:
bearerAuth
path Parameters
subscription-channel
required
string

Channel for which the callback client should get registered for events

query Parameters
subscription-id
string
Example: subscription-id=xxxx-xxxx-xxx-xxxxxxx

Responses

Response samples

Content type
application/json
{
  • "returnCode": "Success",
  • "error": "",
  • "result": {
    }
}

CreateSubscription(oAuth)

CreateSubscription(oAuth)

Authorizations:
bearerAuth
path Parameters
subscription-channel
required
string

Channel for which the callback client should get registered for events

Request Body schema: application/json
callbackURL
string
chaincode
string
event
string
expires
string
maxCallbackRetry
number
type
string

Responses

Request samples

Content type
application/json
Example
{
  • "callbackTLSCerts": {
    },
  • "callbackURL": "{{your_callback_url}}",
  • "chaincode": "{{subscription-chaincode}}",
  • "event": "(CreateShipment|CreateTransportStatus|AppendAttachment)",
  • "expires": "1d",
  • "maxCallbackRetry": 720,
  • "type": "chaincode"
}

Response samples

Content type
application/json
{
  • "returnCode": "Success",
  • "error": "",
  • "result": {
    }
}

DeleteAllSubscriptions

DeleteAllSubscriptions

Authorizations:
bearerAuth
path Parameters
subscription-channel
required
string

Channel for which the callback client should get registered for events

query Parameters
user-id
string
Example: user-id={{auth-username}}
subscription-id
string
Example: subscription-id=xxxx-xxxx-xxxx-xxx-xxx

Responses

Response samples

Content type
application/json
{
  • "returnCode": "Success",
  • "error": "",
  • "result": {
    }
}

Logivity Connect Shipper

This is a collection with examples to create a new Shipments (FTL/LTL)

Shipment & TransportStatus

Create Shipment operation to be used by Shipper

Authorizations:
bearerAuth
path Parameters
cc-channel-shipper
required
string

Carrier Connect Channel Name

header Parameters
x-sender-tracking-id
string
Example: Test_Unique_Tracking

Sender generated Tracking ID

Request Body schema: application/json
args
Array of strings
chaincode
string
sync
boolean
object (v1restproxyapiv2channelsccchannelshippertransactions_transientMap)

Responses

Request samples

Content type
application/json
Example
{
  • "args": [
    ],
  • "chaincode": "ccshipments",
  • "sync": true,
  • "transientMap": {
    }
}

Response samples

Content type
application/json
{
  • "returnCode": "Success",
  • "error": "",
  • "result": {
    }
}

Logivity Connect Carrier

This is a collection with examples to create a new Transport status

Shipment & TransportStatus

Create Transport Status API used by shipper and carrier to update appropriate transport status against shipment

Authorizations:
bearerAuth
path Parameters
cc-channel-carrier
required
string

Carrier Connect Channel Name

header Parameters
x-sender-tracking-id
string
Example: Test_Unique_Tracking

Sender Generated Tracking ID

Request Body schema: application/json
args
Array of strings
chaincode
string
sync
boolean
object (v1restproxyapiv2channelsccchannelcarriertransactions_transientMap)

Responses

Request samples

Content type
application/json
Example
{
  • "args": [
    ],
  • "chaincode": "ccshipments",
  • "peer": "{{sourceURL}}",
  • "timeout": 60000,
  • "transientMap": {
    }
}

Response samples

Content type
application/json
{
  • "returnCode": "Success",
  • "error": "",
  • "result": {
    }
}

Logivity Loadboard Shipper

This is a collection with examples to create a new Shipments (Express)

Shipment & BusinessMessage

Create Shipment operation to be used by ShipperCreateShipment

Authorizations:
bearerAuth
path Parameters
lb-channel-shipper
required
string
header Parameters
x-sender-tracking-id
string
Example: Test_Unique_Tracking

Sender Generated Tracking ID

Request Body schema: application/json
args
Array of strings
chaincode
string
peer
string
timeout
number
object (v1restproxyapiv2channelslbchannelcarriertransactions_transientMap)

Responses

Request samples

Content type
application/json
Example
{
  • "args": [
    ],
  • "chaincode": "loadboard",
  • "sync": true,
  • "transientMap": {
    }
}

Response samples

Content type
application/json
{
  • "returnCode": "Failure",
  • "error": "Transaction processing for endorser [mmn1nonprod-abvolvobc-fra.blockchain.ocp.oraclecloud.com:20041]: Chaincode status Code: (500) UNKNOWN. Description: AcmProcess Error : ERR-COMMON-0000. Internal error. [ValidationShipmentPropagation: no assetId found. ] [ACManager.Run.HandleRequest: not expected error returned.] [ExecuteMethod.executeACMs]"
}

Logivity Loadboard Carrier

This is a collection with examples to create a new Transport status

Shipment & BusinessMessage

Create BusinessMessage API used by shipper and carrier to update appropriate transport status against shipment

Authorizations:
bearerAuth
path Parameters
lb-channel-carrier
required
string
Example: loadboard
header Parameters
x-sender-tracking-id
string
Example: Test_Unique_Tracking

Sender Generated Tracking ID

Request Body schema: application/json
args
Array of strings
chaincode
string
peer
string
timeout
number
object (v1restproxyapiv2channelslbchannelcarriertransactions_transientMap)

Responses

Request samples

Content type
application/json
Example
{
  • "args": [
    ],
  • "chaincode": "loadboard",
  • "sync": true,
  • "transientMap": {
    }
}

Response samples

Content type
application/json
{
  • "returnCode": "Failure",
  • "error": "Transaction processing for endorser [mmn1nonprod-abvolvobc-fra.blockchain.ocp.oraclecloud.com:20041]: Chaincode status Code: (500) UNKNOWN. Description: AcmProcess Error : ERR-COMMON-0000. Internal error. [ValidationShipmentPropagation: no assetId found. ] [ACManager.Run.HandleRequest: not expected error returned.] [ExecuteMethod.executeACMs]"
}