To use the TranspariX Engine API follow these steps:

1. Create a QueryData object containing the shipment (or route) details.
2. POST it to https://rate-engine-api.transparix.com/api/v1/engine
3. Receive a ResultData object containing the list of forwarder service alternatives.

STEP 1: Create A QueryData Object

The QueryData object contains the details of the shipment (or route) and other query parameters (most of them optional). An example:

{
  "databaseCode": "ACME-TEST",
  "divisionCode": "ACME-DIV-01",
  "targetCurrencyCode": "EUR",
  "shipment": 
  {
    "shipmentId": 0,
    "pickup": 
    { 
      "countryCode": "PE", 
      "postalCode": "LIMA18", 
      "requestedDate": "2017-04-18" 
    },
    "delivery": 
    { 
      "countryCode": "NL", 
      "postalCode": "1438AN" 
    },
    "packages": 
    [
      { 
        "packageId": 1, 
        "packageTypeCode": "BOX", 
        "weight": 2.3, 
        "length": 40, 
        "width": 50, 
        "height": 60 
      },
      { 
        "packageId": 2, 
        "packageTypeCode": "BOX", 
        "weight": 2.3, 
        "length": 40,
        "width": 50,
        "height": 60 
      }
    ],
    "packageCount": 2, 
    "totalWeight": 4.6, 
    "totalVolume": 0.24 
  },
  "settings": 
  { 
    "engineVersion": "v8",
    "calculateCostPerPackage": "true",
    "ignoreSurcharges": "true"
  }
}

Some notes:

• The QueryData.DatabaseCode parameter determines the database to connect to. Go to the TranspariX Engine Room to find all the database codes. Read "The QueryData.DatabaseCode Parameter" section for more info.
• You can create the QueryData object from scratch or you can use the Query-Builder endpoint to get started. Read "The Query-Builder Endpoint" section for more info.

STEP 2: POST It

POST the QueryData object to https://rate-engine-api.transparix.com/api/v1/engine

STEP 3: Receive A ResultData Object

The ResultData object contains the list of forwarder services that match the requested query parameters. An example:

{
  "engineVersion": "8.2018.07.17",
  "resultDataVersion": "1.2018.07.25",
  "forwarderServices": 
  [
    {
      "enabled": true,
      "rateCode": "RATE-01",
      "forwarderCode": "DHL",
      "serviceCode": "DHL-X",
      "transitTime": 3,
      "estimatedPickupDate": "2017-12-13",
      "estimatedDeliveryDate": "2017-12-16",
      "deliveryTimeStart": null,
      "deliveryTimeEnd": null,
      "currencyCodeBeforeExchange": "EUR",
      "freightRateBeforeExchange": 120,
      "currencyCode": "EUR",
      "freightRate": 120,
      "totalSurcharge": 0,
      "totalCost": 120
    },
    {
      "enabled": true,
      "rateCode": "RATE-02",
      "forwarderCode": "UPS",
      "serviceCode": "UPS-X",
      "transitTime": 3,
      "estimatedPickupDate": "2017-12-13",
      "estimatedDeliveryDate": "2017-12-16",
      "deliveryTimeStart": null,
      "deliveryTimeEnd": null,
      "currencyCodeBeforeExchange": "EUR",
      "freightRateBeforeExchange": 140,
      "currencyCode": "EUR",
      "freightRate": 140,
      "totalSurcharge": 0,
      "totalCost": 140
    },
  ],
  "shipmentCostBreakdown": 
  {
    "listOfCostPerPackage": 
    [
      {
        "packageId": 1,
        "rateCode": "RATE-01",
        "partOfFreightRate": 60,
        "partOfTotalSurcharge": 0,
        "partOfTotalCost": 60,
        "percentageOfFreightRate": 50,
        "percentageOfTotalSurcharge": 0, 
        "percentageOfTotalCost": 50
      },
      {
        "packageId": 2,
        "rateCode": "RATE-01",
        "partOfFreightRate": 60,
        "partOfTotalSurcharge": 0,
        "partOfTotalCost": 60,
        "percentageOfFreightRate": 50,
        "percentageOfTotalSurcharge": 0,
        "percentageOfTotalCost": 50
      },
      {
        "packageId": 1,
        "rateCode": "RATE-02",
        "partOfFreightRate": 70,
        "partOfTotalSurcharge": 0,
        "partOfTotalCost": 70,
        "percentageOfFreightRate": 50,
        "percentageOfTotalSurcharge": 0, 
        "percentageOfTotalCost": 50
      },
      {
        "packageId": 2,
        "rateCode": "RATE-02",
        "partOfFreightRate": 70,
        "partOfTotalSurcharge": 0,
        "partOfTotalCost": 70,
        "percentageOfFreightRate": 50,
        "percentageOfTotalSurcharge": 0,
        "percentageOfTotalCost": 50
      }
    ],
  "listOfSurchargePerPackage": []
  }
}

 

The QueryData.DatabaseCode Parameter

Running Engine 7

When running Engine 7, only one code (the customer DB code) can be provided. Some (fictional) examples:

• ACME-TEST
• ACME-ACCP
• ACME-PROD

Running Engine 8

When running Engine 8, two codes (the Engine DB code and the customer DB code) separated by a semi-colon can be provided. Some (fictional) examples:

• ENGINE-V8-DB-TEST;ACME-TEST
• ENGINE-V8-DB-ACCP;ACME-ACCP
• ENGINE-V8-DB-PROD;ACME-PROD

The first part is the Engine database code. Some (real) examples:

• ENGINE-V8-DB-TEST
• ENGINE-V8-DB-ACCP
• ENGINE-V8-DB-PROD

The second part is the customer database code. Some (fictional) examples:

• ACME-TEST
• ACME-ACCP
• ACME-PROD

If only one database code is provided, then each environment will connect to its default database (for example: https://rate-engine-api-TEST.transparix.com will connect to the Engine TEST database) and the provided code will be assumed to be the customer database code.

 

The Query-Builder Endpoint

The Query-Builder endpoint builds a QueryData object from an existing shipment.

For TranspariX 7

GET https://rate-engine-api.transparix.com/api/v1/engine/query-builder/tx7/{databaseCode}/{shipmentId}

• The databaseCode identifies the database to connect to. Go to the TranspariX Engine Room to find all the database codes.
• The shipmentId identifies the shipment to use to build the QueryData object.

---