GET api/v1/engine/query-builder/{transparixVersion}/{databaseCode}/{shipmentId}

Builds a QueryData object from an existing shipment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
transparixVersion

The code that identifies the TranspariX version (and also identifies the database model).

 string

Required
databaseCode

The code that identifies the database to connect to.

 string

Required
shipmentId

The number that identifies the shipment to use to build the QueryData object.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

QueryData
NameDescriptionTypeAdditional information
DatabaseCode

The code that identifies the database to connect to. When using Engine 7 only the customer database code is required (for example: ACME-TEST). When using Engine 8 both the Engine 8 database code and the customer database code are required (for Example: ENGINE-V8-DB-TEST;ACME-TEST). If only the customer database code is provided, then the default Engine 8 database for the current environment will be used.

 string

Required
DivisionCode

The code that identifies the business division to which the shipment (or route) belongs. Only freight rates and surcharges linked to this division will be returned.

 string

Required
DivisionGroupCode

The code that identifies the group of this business division.

 string

None.
DivisionCountryCode

The code that identifies the country of this business division.

 string

None.
TargetCurrencyCode

The 3-letter ISO code of the target currency. If NOT set, then the default value is "EUR".

 string

None.
Shipment

The data of the shipment and its packages.

 Shipment

None.
Route

The data of the route and its stops. If set, then the shipment object is ignored and the route cost is calculated instead.

 Route

None.
ContractTypeCodes

The codes of the requested types of contracts. These values indicate the kind of freight rates and surcharges to look for. Do NOT set this value to look for all freight rates and surcharges.

 Collection of string

None.
ForwarderCodes

The codes of the requested forwarders. Do NOT set this value to look for freight rates of all forwarders.

 Collection of string

None.
ServiceCodes

The codes of the requested services. Do NOT set this value to look for freight rates of all services.

 Collection of string

None.
ServiceGroupCodes

The codes of the requested service-groups. Do NOT set this value to look for freight rates of all services.

 Collection of string

None.
ExcludeSurchargeCodes

The codes of the surcharges to be excluded. Two wildcards are allowed: The asterisk (*) meaning "any string of zero or more characters", and the question mark (?) meaning "any single character".

 Collection of string

None.
IncotermCode

The code of the requested INCOTERM. Do NOT set this value to look for freight rates of any INCOTERM. This is also used to determine which surcharges are applicable.

 string

None.
ChargeableFactorCode

The code of the requested chargeable factor. Indicates the dimension used to calculate the freight rate. Shipment freight rates are based on "PACKAGE-COUNT" or "WEIGHT". Route freight rates are based on "DISTANCE" or "TIME". Do NOT set this value to look for freight rates of any chargeable factor.

 string

None.
RateCode

The code of the requested freight rate. Set this value to look for a specific freight rate. Do NOT set this value to look for all freight rates

 string

None.
ExchangeRates

A collection of exchange rates (as currency codes and their values). Exchange rates must be quoted against the TargetCurrencyCode parameter.

 Dictionary of string [key] and decimal number [value]

None.
Settings

A collection of setting keys and their values. Examples: "bookingCutOffTime", "calculateCostPerPackage", "calculateCostPerShipment", "calculateCostPerStop", "currentDateTime", "includeAllIncoterms", "returnMoreInfo".

 Dictionary of string [key] and string [value]

None.
EngineDataVersion

The version of the TranspariX.Engine.DataClasses project.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "databaseCode": "sample string 1",
  "divisionCode": "sample string 2",
  "divisionGroupCode": "sample string 3",
  "divisionCountryCode": "sample string 4",
  "targetCurrencyCode": "sample string 5",
  "shipment": null,
  "route": null,
  "contractTypeCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "forwarderCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "serviceCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "serviceGroupCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "excludeSurchargeCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "incotermCode": "sample string 6",
  "chargeableFactorCode": "sample string 7",
  "rateCode": "sample string 8",
  "exchangeRates": {
    "sample string 1": 2.0,
    "sample string 3": 4.0
  },
  "settings": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "engineDataVersion": "1.20.7.2"
}

application/xml, text/xml

Sample: 
<QueryData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TranspariX.Engine.DataClasses">
  <ChargeableFactorCode>sample string 7</ChargeableFactorCode>
  <ContractTypeCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContractTypeCodes>
  <DatabaseCode>sample string 1</DatabaseCode>
  <DivisionCode>sample string 2</DivisionCode>
  <DivisionCountryCode>sample string 4</DivisionCountryCode>
  <DivisionGroupCode>sample string 3</DivisionGroupCode>
  <ExchangeRates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringdecimal>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>2</d2p1:Value>
    </d2p1:KeyValueOfstringdecimal>
    <d2p1:KeyValueOfstringdecimal>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>4</d2p1:Value>
    </d2p1:KeyValueOfstringdecimal>
  </ExchangeRates>
  <ExcludeSurchargeCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeSurchargeCodes>
  <ForwarderCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ForwarderCodes>
  <IncotermCode>sample string 6</IncotermCode>
  <RateCode>sample string 8</RateCode>
  <Route i:nil="true" />
  <ServiceCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ServiceCodes>
  <ServiceGroupCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ServiceGroupCodes>
  <Settings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Settings>
  <Shipment i:nil="true" />
  <TargetCurrencyCode>sample string 5</TargetCurrencyCode>
</QueryData>