Support Portal

Using 7S Transport API

Workflow

Authorization

DAT API is secured, so every API request should be authorized with an authorization token.

To request new token please use your credentials (username and password) provided you by Seven Senders.


POST https://staging.data.7senders.com/api/token{"username":"YOUR USERNAME","password":"YOUR PASSWORD"}

You will receive a token in the response, which you should attach in any further request as a header parameter:


Authorization: Bearer YOUR_TOKEN

My Profile

Use following  request to get your user's profile:


GET https://staging.data.7senders.com/api/me

Fetching Consignment List

To be able to report anything, you have to request the list of existing consignment.

Outbound consignments


GET https://staging.data.7senders.com/api/consignments?route.relation.type=Outbound(Customer to LMC)&itemsPerPage=100&plannedPickUpTime[before]=2018-01-22T22:59:00.000Z&plannedPickUpTime[after]=2018-01-17T23:00:00.000Z&order[plannedPickUpTime.from]=ASC

Return consignments


GET https://staging.data.7senders.com/api/consignments?route.relation.type=Return(LMC to Customer)&itemsPerPage=100&plannedPickUpTime[before]=2018-01-22T22:59:00.000Z&plannedPickUpTime[after]=2018-01-17T23:00:00.000Z&order[plannedPickUpTime.from]=ASC

Please note: following examples contain filters by type, range of planned pick up time and limits the result set to 100 records.

Consignment export

Using similar request to ones above (same filters set), you can download the list of cosignment CSV file format


GET https://staging.data.7senders.com/api/consignments/export?route.relation.type=Outbound(Customer to LMC)&itemsPerPage=1000&plannedPickUpTime[before]=2018-01-22T22:59:00.000Z&plannedPickUpTime[after]=2018-01-17T23:00:00.000Z&order[plannedPickUpTime.from]=ASC

Just add extra parameter in headers:


Accept: text/csv

Reporting quantities

Planned value

PUT https://staging.data.7senders.com/api/consignments/3086
{
  "id": 3086,
  "actual_pick_up_time": null,
  "total_parcels_quantity": null,
  "unit_quantity_list": {
    "PAL": {
      "dispatch_unit_type": {
        "id": 3
      },
      "planned_quantity": 123,
      "picked_up_quantity": 0,
      "dropped_off_quantity":   0,
      "id": 3086
    }
  }
}


Actual pick up value

PUT https://staging.data.7senders.com/api/consignments/3086
{
  "id": 3086,
  "actual_pick_up_time": "2017-01-19T11:00:00.000Z",
  "total_parcels_quantity": 1050,
  "unit_quantity_list": {
    "PAL": {
      "dispatch_unit_type": {
        "id": 3
      },
      "planned_quantity": 123,
      "picked_up_quantity": 120,
      "dropped_off_quantity":   0,
      "id": 3086
    }
  }
}


Actual drop off value

PUT https://staging.data.7senders.com/api/consignments/3086
{
  "id": 3086,
  "actual_drop_off_time": "2017-01-19T11:00:00.000Z",
  "total_parcels_quantity": 1050,
  "unit_quantity_list": {
    "PAL": {
      "dispatch_unit_type": {
        "id": 3
      },
      "planned_quantity": 123,
      "picked_up_quantity": 0,
      "dropped_off_quantity": 120,
      "id": 3086
    }
  }
}

Where

  • 3086 - the cosingment ID,
  • total_parcels_quantity (1050) - total number of parcels injected in pallets,
  • actual_drop_off_time, actual_pick_up_time - time when the transport arrived for drop off or pick up
  • dispatch_unit_type {"id":3} - required field, it says that the consignment consists of Palettes

Contact Information


GET https://staging.data.7senders.com/api/contacts

Request will return contact information from Seven Senders: 

  • Key Account Manager
  • Managers for each active relation
  • Last Mile Carrier

API Documentation

You may find more details in our API documentation and Sandbox be the following link:

https://staging.data.7senders.com/api/docs.html

Please request from us an username and password for Authentication to reach this page.

Contact email: service@sevensenders.com