Integration FAQs

Irina Abramova
Irina Abramova
  • Updated

This article aims to support carriers with integration development by addressing most common API integration related questions. You can find the list of FAQs on the right, and follow the link to a relevant section of this article. If you are missing any information, feel free to reach out to Logivity Support.

Explanation of Logivity services

Logivity Control/Connect

Transport execution service used for contracted shipments and awarded spot-buy shipments. In this service you Accept/Decline shipments sent to you and report transport progress.

Please note, that if you are using Control/Connect for awarded spot-buy shipments, awarded shipment you receive in the service will automatically come in "Accepted" state and it won't be possible to decline it.

Logivity Loadboard

Spot-bidding service where transport buyer auctions a shipment offer to several carrier and awards the shipment to the most suitable bidder. In this service you can only receive shipment offers and bid on them. Once you win a shipment offer, the execution process continues in Logivity Connect/Control and the shipment will be automatically transferred there in "Accepted" state by the system.

Logivity Visibility

A real-time shipment status tracking service connected to Logivity Connect/Control. To enable this service you need to onboard to Logivity Visibility partner and connect your fleet. Once activated, you will report the specific license plate number for each of your shipments to enable the tracking. Tracking starts at Proof of pick-up (PoP) and ends after Proof of Arrival (PoA) confirmation. Details about onboarding to Logivity Visibility service are described in "How do I onboard to Visibility?" section. 

How do I get started as a Carrier?

To begin your integration, make sure to obtain a test account on Logivity platform. To get that, please register under this link: https://ccapp-test.tmaorg.io/login/signin.html. 

When onboarding, please select the following roles:

  • Shipper - so that you can create test shipments for yourself
  • Carrier - so that you can bid, accept and report on transport progress

Select the following services:

  • Logivity Control
  • Logivity Loadboard
  • Logivity Visibility

Once your registration is submitted, Logivity team will review and accept it. You will receive an email with an account activation link after your account has been approved, and will be able to login and start using it.

 

How do I get my API credentials?

You will receive a set of credentials for each environment upon your account creation. To access your credentials for TEST:

For accessing PRODUCTION environment credentials, login to your PROD account here: https://carrierconnect.tma.io/login/signin.html and follow the same steps as described above.

How do I create a subscription?

Instructions for creating an event subscription are available in Logivity API documentation: https://api-doc.logivity.com/eventguide/eventguide.html#basic-flow-for-event-subscription

EventNotification message flow can be viewed here: https://api-doc.logivity.com/eventguide/EventNotification.html

Control/Connect channel

This applies to contracted shipment types, where you are the only carrier invited to execute the transport. API documentation for Control/Connect events is available here: https://api-doc.logivity.com/eventguide/eventguide.html#1-connect-events-supported-by-logivity-connect 

You will subscribe to event notifications and can choose which type of notifications you want to receive:

  • CreateShipment notification - you will receive an event notification upon shipment creation. Event notification will contain a unique shipment identifier (CargoAssetID) which you in turn need to use to make a subsequent API call (GetShipment) to retrieve complete shipment details. Shipment details are base64 encoded and need to be decoded to view the shipment data.
  • CreateTransportStatus notification - allows you to transfer the shipment data to your TMS after that shipment has been accepted by your organization rather than when it is assigned/tendered. If you wish to use this event, please reach out to Logivity team to enable it.
  • AppendAttachment notification - allows you to subscribe to notifications containing attachments/documents, if for example shipper attaches a document to the transport booking.

You can choose yourself which events to subscribe to depending on your preferences or subscribe to all 3.

JSON examples can be downloaded here: https://api-doc.logivity.com/eventguide/SampleJSONResponses.html

Loadboard channel

This applies to spot-buy shipment types where a shipment is auctioned first and assigned to the winning bidder.

Please note, if you handle spot-buy shipment types you also need to subscribe to Control/Connect channel to receive event notifications for shipments you win.

Loadboard channel contains private events. API documentation for Loadboard events is available here: https://api-doc.logivity.com/eventguide/eventguide.html#2-loadboard-events-supported-by-logivity-loadboard

For Loadboard notifications "EventName" field is not present. You can explore the Message Flow for Loadboard subscription here: https://api-doc.logivity.com/eventguide/CreateBusinessMessage.html

JSON examples can be downloaded here: https://api-doc.logivity.com/eventguide/SampleJSONResponses.html

Event Replay

In some cases events can be missed, for example if your subscription has expired. To retrieve missing events you can use "Events Replay" functionality, instructions for which can be found here: https://support.logivity.com/hc/en-us/articles/19780844290461-Chaincode-Event-Replay

How can I test my subscription?

Once your subscription has been created, you will receive a a REST proxy callback test request. You can find the description and details here: https://api-doc.logivity.com/eventguide/eventguide.html#3-acknowledge-a-test-callback-request

How do I create test shipments?

For testing purposes during your development process you can create shipments yourself on your test account. Please note that you need to have a "Shipper" role to be able to create test shipments. If you are missing Shipper role, you can add it by going to "Settings" -> "Services" -> Scroll down to "Organisation roles" section and click into "Shipper" checkbox. Remember to save your changes.

You can change between "Shipper" and "Carrier" views by selecting the view you need in the top right corner drop-down menu:

How do I send bids (Loadboard)?

You can bid in the Logivity web application or via the integration.

Bid via the Web Application

When you receive a new shipment offer, in the status column of the Loadboard shipment list you will see a green button with "Bid" text. 

Follow these instructions to place a Standard bid: https://support.logivity.com/hc/en-us/articles/14576844320157-How-to-bid-on-a-shipment-offer#h_01HTMEMF7JJVMQPRZG0XR8BTPC

Bid via Integration

Here you can find the relevant API documentation links:

How do I send transport status (Control/Connect)?

Transport status can be reported via the Web Application or Integration. 

Report Transport Status via the Web Application

Report Transport Status via the Integration

Here you can find the relevant API documentation links:

How do I onboard to Visibility?

To begin onboarding to Visibility service, Logivity team will share an invitation link with you which you can use to register to our Visibility partner CO3. Please reach out to the Logivity Support team to initiate your onboarding: https://support.logivity.com/hc/en-us/requests/new?ticket_form_id=35268125130013

Once you account has been created, CO3 Team will guide you through the onboarding process.

Contact for support

If you have any questions or require support please raise a ticket to our support team by clicking here.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.