API Docs ENG

2020
API Documentation
ALEXANDER TOPORENKO
TMM EXPRESS | Версия от 01.04.2020

Contents
General terms ............................................................................................. Error! Bookmark not defined.
API request format .................................................................................. Error! Bookmark not defined.
Interaction scheme ................................................................................. Error! Bookmark not defined.
Shipment .................................................................................................... Error! Bookmark not defined.
Shipment creation................................................................................... Error! Bookmark not defined.
Request structure ............................................................................................................................ 4
Description of fields ........................................................................................................................ 6
Shipment edit ......................................................................................... Error! Bookmark not defined.
Request structure .......................................................................................................................... 11
Description of fields...................................................................................................................... 12
Create a sticker ........................................................................................... Error! Bookmark not defined.
Description of fields ...................................................................................................................... 18
Structure of response in case of error............................................................................................ 18
Courier Pickup ............................................................................................ Error! Bookmark not defined.
Create a shipment pickup order .............................................................. Error! Bookmark not defined.
Response structure ....................................................................................................................... 21
Shipment tracking ....................................................................................... Error! Bookmark not defined.
Shipment Tracking by the number or marks of the sender ...................... Error! Bookmark not defined.
Receiving the last (current) status of a shipment ..................................... Error! Bookmark not defined.
Receiving the current status of a shipment.............................................. Error! Bookmark not defined.
https://tmm-express.com
2
Error codes ................................................................................................. Error! Bookmark not defined.
Getting information about an error ......................................................... Error! Bookmark not defined.
Getting the error reference ..................................................................... Error! Bookmark not defined.
Additions .................................................................................................... Error! Bookmark not defined.
List of available Products, Services and additional options ....................... Error! Bookmark not defined.
List of Products ................................................................................... Error! Bookmark not defined.
List of Services..................................................................................... Error! Bookmark not defined.
List of additional options ............................................................................................................... 32
List of shipment statuses ......................................................................... Error! Bookmark not defined.
Invoice form............................................................................................ Error! Bookmark not defined.
Shape of stickers ..................................................................................... Error! Bookmark not defined.
Proforma Invoice Form............................................................................ Error! Bookmark not defined.
3
General terms
To work with the TMM Express API, you must have a TMM client number, as well as a login and
password. In order to get a client number, you need to send a request to contract@tmm-express.com.
If you are an existing client, you can check the client number with your Manager or calling to our contact
center.
To get a login and password, you must send a letter to api@tmm-express.com with your client number.
API request format

API is built on REST architecture. The requests use HTTP methods GET and POST.
For authorization, you must use the Basic scheme - the username and password are transmitted in the
Authorization header in unencrypted form (base64-encoded).
Для передачи информации в теле запроса используется формат XML.
The request URL consists of the server address, the {environment}, and the endpoint of the
request.{environment}:
Test environment – tmmtest3
Work environment - tmm
To get the latest API documentation, you need to send a GET request to the URL: http://api.tmm-
express.com/tmm/hs/docs/api
Interaction scheme
The client The client fills in

The TMM invoice
integrates his the data about the TMM system Customer prints
is sent to the client
system with the shipment in his creates shipment invoice
in PDF format
TMM Express API accounting system
The client hands

The client tracks
The client marks The client calls over the
the status of the
the package the courier package to the
package
courier.
Shipment
Shipment creation
This function is used to register a shipment and create a bill of lading.
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/v3/Shipping/SaveConnote
Request method: POST
Format: XML
4
<?xml version="1.0" encoding="utf-8"?>
<connote getNumber="true" getOrder="false">
<number></number>
<contragents>
<payer></payer>
<paymentType></paymentType>
<sender>
<account></account>
<companyName></companyName>
<address></address>
<city></city>
<postalCode></postalCode>
<province></province>
<countryCode></countryCode>
<contactName></contactName>
<phone></phone>
<email></email>
</sender>
<receiver>
<account></account>
<address></address>
<city></city>
<phone></phone>
<email></email>
</receiver>
<delivery>
<address></address>
<city></city>
<phone></phone>
</delivery>
<thirdParty>
<account></account>
</thirdParty>
</contragents>
<customerReference></customerReference>
<additionalInfo></additionalInfo>
<shipmentDetails>
<fullDescription></fullDescription>
<contents>
5
<content items="" weight="" length="" width="" height=""/>
</contents>
<dutiable currencyCode="" value="" commodityCode=""/>
<isDangerous></isDangerous>
</shipmentDetails>
<services>
<product></product>
<serviceCode></serviceCode>
<options>
<option>
<code></code>
</option>
</options>
</services>
<invoiceDetails>
<invoicePosition>
<packageType></packageType>
<commodityCode></commodityCode>
<unitsOfMeasure></unitsOfMeasure>
<numberOfUnits></numberOfUnits>
<unitValue></unitValue>
</invoicePosition>
</invoiceDetails>
</connote>
Where:
Element Include elements Mandatory filling Descriptions
connote getNumber Main tag

getOrder
number
contragents
customerReference
additionalInfo
shipmentDetails
services
invoiceDetails
getNumber Yes Connote tag’s attribute. Can take on
the values true or false.
getOrder Yes Connote tag’s attribute. Can take on
the values true or false.
number Yes/No String tag. Containes the TMM
invoice number. Заполняется, когда
атрибута getNumber - false
contragents payer Block tag. Contains information
paymentType about the sender, recipient, third
sender party, delivery address and who is
receiver the payer of the transportation
delivery
6
thirdParty
payer yes String tag. Contains information
about who is the payer of
transportation. Sender, Receiver,
ThirdParty
paymentType yes String tag. Contains information how
the shipment will be paid.
If the value is 0 - cashless settlement,
if the value is 1 - cash settlement.
sender account Block tag. Contains information
companyName about the sender.
address
city
postalCode
province
countryCode
contactName
phone
email
account yes/no
String tag. Contains the sender's
TMM client number.
companyName yes String tag. Contains the sender's
name / sender's company name.
address yes String tag. Contains the sender's
address.
city yes String tag. Contains the sender's city.
postalCode yes String tag. Contains the postal code
of the sender.
province no String tag. Contains the area
(district) of the sender.
countryCode yes String tag. Contains the country code
of the sender. Specified in the
format ISO 3166-1 Alpha-2
contactName yes String tag. Contains the contact
person /sender.
phone yes String tag. Contains the sender's
phone number.
email no String tag. Contains the sender's
email address.
receiver account Block tag. Contains information
companyName about the recipient.
address
city
postalCode
province
countryCode
contactName
phone
email
account Да/Нет String tag. Contains the recipient's
TMM client number
7
companyName yes String tag. Contains the recipient's
name / recipient's company name.
address yes String tag. Contains the recipient's
address.
city yes String tag. Contains the city of the
recipient.
postalCode yes String tag. Contains the postal code
of the recipient.
province no String tag. Contains the region
(district) of the recipient.
countryCode yes String tag. Contains the recipient
country code. Specified in the format
ISO 3166-1 Alpha-2
contactName yes String tag. Contains the recipient's
contact person.
phone yes String tag. Contains the recipient's
phone number.
email no String tag. Contains the recipient's
email address.
delivery companyName Block tag. Contains information
address about the delivery address if
city different from the recipient's
postalCode address.
province
countryCode
contactName
phone
companyName no String tag. Contains the recipient's
name / recipient's company name.
address no String tag. Contains the recipient's
address.
city no String tag. Contains the city of the
recipient.
postalCode no String tag. Contains the postal code
of the recipient.
province no String tag. Contains the region
(district) of the recipient.
countryCode no String tag. Contains the recipient
country code. Specified in the format
ISO 3166-1 Alpha-2
contactName no String tag. Contains the recipient's
contact person.
phone no
String tag. Contains the
recipient's phone number.
thirdParty companyName Block tag. Contains information

account about the Third Party payer.
companyName yes / no String tag. Contains the name of the
8
company.
account yes/no String tag. Contains the TMM client
number
customerReference no String tag. Contains the sender's
marks (internal order number,
project number, etc.).
additionalInfo no String tag. Contains additional
shipping instructions.
shipmentDetails fullDescription Block tag. Contains a description of
contents the contents of the shipment.
dutiable
isDangerous
fullDescription yes String tag. Contains a description of
the contents of the shipment.
contents content Block tag. Contains content details.
May contain multiple tags content
content items String tag. Contains information
weight about the weight and dimensions of
length the shipment
width
height
items yes The content tag attribute. Contains
information about the number of
content places with the same weight
and dimensions.
weight yes The content tag attribute. Contains
information about the weight of the
shipment.
length yes The content tag attribute. Contains
information about how long the
shipment is.
width yes The content tag attribute. Contains
information about the width of the
shipment.
height yes The content tag attribute. Contains
information about the height of the
departure
dutiable currencyCode String tag. Contains information for
value customs.
commodityCode
currencyCode The tag attribute is dutiable.
Contains information about the
currency code in the format
ISO 4217 alfa-3
value The dutiable tag attribute. Contains
information about the cost of the
entire contents of the shipment
commodityCode The dutiable tag attribute. Contains
the customs code of the goods
isDangerous yes String tag. A parameter indicating
the danger of the shipment’s
contents. If the value is true, then
9
the cargo is dangerous, if false, then
the contents of the cargo do not
belong to dangerous cargo.
services product Block tag. Contains information
serviceCode about the service, additional options
options and type of shipment.
product yes String tag. Contains information
about the type of content. If
documents, then the value -
Documents, for all other items the
value – NonDocuments.
serviceCode yes String tag. Contains the coding of the
TMM service. The list of services and
their encoding are available by
ссылке
options option Block tag. Contains information
about additional options for the
service. Can contain multiple blocks
option
option code Block tag. Contains information
about an additional option for the
service.
code no String tag. Contains the encoding of
an additional option to the service. A
list of additional options and their
encoding are available by ссылке.
invoiceDetails invoicePosition Block tag. Contains information for
creating an invoice. Can contain
multiple blocks invoicePosition
invoicePosition packageType Block tag. Contains information
fullDescription about the item in the invoice
commodityCode
unitsOfMeasure
numberOfUnits
unitValue
packageType String tag. Contains information
about the type of packaging.
The following values can be used:
Bag, Box, Carton, Crate, Drum,
Envelope, Europallet, Pallet, Pieces,
Roll, Satchels
fullDescription String tag. Contains a detailed
description of the content for this
position in the invoice.
commodityCode String tag. Contains the customs
code of the goods (ТНВЭД)
unitsOfMeasure String tag. Contains units of
measure. The following values can
be used: Pieces, Package, Kilogram,
Liter, Meter, SquareMeter
numberOfUnits String tag. Contains the number of
items for a given item in the invoice.
10
unitValue String tag. Contains the cost of one
unit of goods for a given item in the
invoice.
Editing items
This function is used to edit the properties of a shipment. Changes will apply provided that the waybill
has not yet been accepted for transportation. In the request, you must pass all the properties of the
invoice, and not just the changed items.
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Shipping/EditConnote
Method: POST
Format: XML
<editConnote>
<number></number>
<contragents>
<payer></payer>
<sender>
<account></account>
<address></address>
<city></city>
<phone></phone>
<email></email>
</sender>
<receiver>
<account></account>
<address></address>
<city></city>
<phone></phone>
<email></email>
</receiver>
<delivery>
<address></address>
<city></city>
11
<phone></phone>
</delivery>
<thirdParty>
<account></account>
</thirdParty>
</contragents>
<customerReference></customerReference>
<additionalInfo></additionalInfo>
<shipmentDetails>
<contents>
<content items="" weight="" length="" width="" height=""/>
</contents>
<dutiable currencyCode="" value="" commodityCode=""/>
<isDangerous></isDangerous>
</shipmentDetails>
<services>
<product></product>
<serviceCode></serviceCode>
<options>
<option>
<code></code>
</option>
</options>
</services>
<invoiceDetails>
<invoicePosition>
<packageType></packageType>
<commodityCode></commodityCode>
<unitsOfMeasure></unitsOfMeasure>
<numberOfUnits></numberOfUnits>
<unitValue></unitValue>
</invoicePosition>
</invoiceDetails>
</editConnote>
Where:
Element Include elements Mandatory Descriptions
filling
editConnote number Main tag.
contragents
customerReference
additionalInfo
12
shipmentDetails
services
invoiceDetails
number yes String tag. Contains the number of the
TMM invoice where need to do changes.
contragents payer Block tag. Contains information about
paymentType the sender, recipient, third party,
sender delivery address and who is the payer of
receiver the transportation
delivery
thirdParty
payer String tag. Contains information about
who is the payer of transportation.
Sender, Receiver, ThirdParty
paymentType String tag. Contains information the
shipment will be paid. If the value is 0 -
cashless settlement, if the value is 1 -
cash settlement.
sender account Block tag. Contains information about
companyName the sender.
address
city
postalCode
province
countryCode
contactName
phone
email
account String tag. Contains the sender's TMM
client number.
companyName String tag. Contains the sender's name /
sender's company name.
address String tag. Contains the sender's
address.
city String tag. Contains the sender's city.
postalCode String tag. Contains the postal code of
the sender.
province String tag. Contains the area (district) of
the sender.
countryCode String tag. Contains the country code of
the sender. Specified in the format
ISO 3166-1 Alpha-2
contactName String tag. Contains the contact person
of the sender.
phone String tag. Contains the sender's phone
number.
email String tag. Contains the sender's email
address.
receiver account
companyName
13
address
city
postalCode
province
countryCode
contactName
phone
email
account String tag. Contains the recipient's TMM
client number.
companyName String tag. Contains the recipient's name
/ recipient's company name.
address String tag. Contains the recipient's
address.
city String tag. Contains the city of the
recipient.
the recipient.
province String tag. Contains the region (district)
of the recipient.
countryCode String tag. Contains the recipient country
code. Specified in the format ISO 3166-
1 Alpha-2
contactName String tag. Contains the recipient's
contact person.
phone String tag. Contains the recipient's
phone number.
email String tag. Contains the recipient's email
address.
delivery companyName Block tag. Contains information about
address the delivery address if it is different from
city the recipient's address.
postalCode
province
countryCode
contactName
phone
companyName String tag. Contains the recipient's name
/ recipient's company name.
address String tag. Contains the recipient's
address.
city String tag. Contains the city of the
recipient.
the recipient.
province String tag. Contains the region (district)
of the recipient.
countryCode String tag. Contains the recipient country
code. Specified in the format ISO 3166-
1 Alpha-2
14
contactName String tag. Contains the recipient's
contact person.
phone String tag. Contains the recipient's
phone number.
thirdParty companyName Block tag. Contains information about
account the Third Party payer.
companyName String tag. Contains the name of the
company.
account String tag. Contains the TMM client
number.
customerReference String tag. Contains the sender's marks
(internal order number, project, etc.).
additionalInfo String tag. Contains additional shipping
instructions.
shipmentDetails fullDescription Block tag. Contains a description of the
contents contents of the shipment.
isDangerous
fullDescription String tag. Contains a description of the
contents of the shipment.
contents content Block tag. Contains content details. May
contain multiple tags content
content items String tag. Contains information about
weight the weight and dimensions of the
length shipment
width
height
items The content tag attribute. Contains
information about the number of
content places with the same weight and
dimensions.
weight The content tag attribute. Contains
information about the weight of the
shipment.
length The content tag attribute. Contains
information about how long the
shipment is.
width The content tag attribute. Contains
information about the width of the
parcel.
height The content tag attribute. Contains
information about the height of the
departure
dutiable currencyCode String tag. Contains information for
value customs.
commodityCode
currencyCode The dutiable tag attribute. Contains
information about the currency code in
the format ISO 4217 alfa-3
value The dutiable tag attribute. Contains
information about the cost of the entire
contents of the shipment
15
commodityCode The dutiable tag attribute. Contains the
customs code of the goods
isDangerous String tag. A parameter indicating the
danger of the contents of the shipment.
If the value is true, then the cargo is
dangerous, if false, then the contents of
the cargo do not belong to dangerous
cargo.
services product Block tag. Contains information about
serviceCode the service, additional options and type
options of shipment.
product String tag. Contains information about
the type of content. If documents, then
the value is Documents, for all other
items the value is NonDocuments.
serviceCode String tag. Contains the coding of the
TMM service. The list of services and
their encoding are available by ссылке
options option Block tag. Contains information about
additional options for the service. May
contain multiple blocks option
option code Block tag. Contains information about an
additional option for the service.
code String tag. Contains the encoding of an
additional option to the service. A list of
additional options and their encoding
are available by ссылке.
invoiceDetails invoicePosition Block tag. Contains information for
creating an invoice. May contain
multiple blocks invoicePosition
invoicePosition packageType Block tag. Contains information about
fullDescription the item in the invoice
commodityCode
unitsOfMeasure
numberOfUnits
unitValue
packageType String tag. Contains information about
the type of packaging.
The following values can be used: Bag,
Box, Carton, Crate, Drum, Envelope,
Europallet, Pallet, Pieces, Roll, Satchels
fullDescription String tag. Contains a detailed
description of the content for this
position in the invoice.
commodityCode String tag. Contains the customs code of
the goods
unitsOfMeasure String tag. Contains units of
measurement. The following values can
be used: Pieces, Package, Kilogram,
Liter, Meter, SquareMeter
numberOfUnits String tag. Contains the number of items
for a given item in the invoice.
16
unitValue String tag. Contains the cost of one unit
of goods for a given item in the invoice.
If successful, the response code 204.

In case of error, the response code 200.
Structure of response in case of error:

Format: XML

<editConnote>
<error></error>
</editConnote>
where,
editConnote error Main tag.

error yes String tag. Contains an error code
17
Creating a sticker
The function is used to print marking stickers that are attached to individual places of the same
shipment
Request structure:
URL: http://api.tmm-
express.com/{environment}/hs/MobileWarehouse/labelPrint/{AWB_number}/{piece_number}
Method: POST
Request body is empty
Description of fields:
{AWB_number} – invoice number for which you need to get a sticker.
{piece_number} – location number for which you need to get a sticker. If the value is 0, the system will
return stickers for all locations.
Example of a request for a specific location:

http://api.tmm-express.com/{environment}/hs/MobileWarehouse/labelPrint/6871162934/2
Example of a request for all points of departure:

http://api.tmm-express.com/{environment}/hs/MobileWarehouse/labelPrint/6871162934/0
If successful, the response code 200. In the body of the response, the system will transmit the PDF file
encoded in Base64.
Structure of the response in case of an error:

Format: XML

<labelPrint>
<exception> Error description </exception>
</labelPrint>
18
Courier call
Creation of an order for the collection of cargo
The function is used to call a courier
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Shipping/SavePickupOrder
Method: POST
Format: XML
<pickupOrder>
<client>
<account></account>
<phone></phone>
<email></email>
</client>
<pickupContact>
<phone></phone>
<email></email>
</pickupContact>
<pickupAddresses>
<address></address>
<city></city>
</pickupAddresses>
<connotes>
<number></number>
</connotes>
<collectionDate></collectionDate>
<opsInfo>
<workSchedule startTime="" endTime=""/>
<lunchHour startTime="" endTime=""/>
<instructions/>
</opsInfo>
</pickupOrder>
pickupOrder client Main tag

pickupContact
pickupAddresses
connotes
paymentType
19
collectionDate
opsInfo
client account Information about the customer
companyName who ordered courier
contactName
phone
email
account yes Customer account
companyName Client name
contactName yes Client name
phone yes Customer phone
email Client Email
pickupContact contactName Information about the sender,
phone where to pick up the shipment
email
contactName Full name of the sender
phone Sender's phone
email Sender email
PickupAddresses address Pickup address
city
postalCode
province
countryCode
address yes Street, house number where need
to pick up the shipment
city yes Locality where need to pick up the
shipment
postalCode yes Zip code of the settlement where
need to pick up the items
province The area of the settlement where
need to pick up the shipment
countryCode yes Country code where need to pick
up the shipment
connotes number Contains a list of
invoices to be picked up. May
contain multiple tags <number>
number no TMM invoice number
paymentType yes String tag. Contains information
on how the shipment will be paid.
If the value is 0 - cashless
settlement, if the value is 1 - cash
settlement.
collectionDate yes Courier arrival date
opsInfo workSchedule
lunchHour
instructions
workSchedule Work time
lunchHour Lunch
instructions Courier instructions
20
Структура ответа:
Format: XML

<pickupOrder>
<number><number>
</pickupOrder>
pickupOrder number Main tag

number yes String tag. Contains the number
assigned to the order.

Response structure:
Format: XML

<pickupOrder>
<errors>
<error code=””></error>
</errors>
</pickupOrder>
pickupOrder errors Main tag

errors error yes String tag. Contains the number
assigned to the order. May
contain multiple tags error.
error code yes String tag. Contains data that
caused the error.
code The error tag attribute. Contains
an error code. Information on
errors can be viewed здесь
21
Shipment tracking
Tracking shipment by number or sender marks
The function is used to get all the shipment statuses.
Tracking is possible by the TMM invoice number or by the sender's marks specified in the tag
<customerReference>.
Group tracking requires multiple tags <number> and / or <reference>, but not more than 50.
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Tracking/GetDetailedStatusInfo
Method: POST
Format: XML
<tracking>
<sender account="" countryCode=" "/>
<connotes>
<number></number>
<reference></reference>
</connotes>
<translation countryCode="GB"/>
</tracking>
tracking Main tag.

sender account String tag. Contains information
countryCode about the client number and
country of the sender
account no Sender tag attribute. Contains the
sender's TMM client number
countryCode no Sender tag attribute. Contains the
country code of the sender.
Specified in the format ISO 3166-
1 Alpha-2
connotes number Block tag. May contain multiple
reference tags <number> and <reference>
number no String tag. Contains the number of
the TMM invoice that needs to be
tracked.
reference no String tag. Contains the sender's
marks (internal number of the
order, project, etc.) by which you
need to track the invoice.
translation countryCode String tag. Determines in what
language the answer will be
displayed.
countryCode yes Translation tag attribute. Country
code, the language that was
selected to display the response to
22
the request. Specified in the
format ISO 3166-1 Alpha-2.
Available options: GB-English, RU-
Russian, UA-Ukrainian, PL-Polish

Response structure:
Format: XML

<tracking>
<connotes>
<connote>
<statusId></statusId>
<number></number>
<originDepotName></originDepotName>
<collectionDate></collectionDate>
<deliveryTown></deliveryTown>
<deliveryDate></deliveryDate>
<deliveryTime></deliveryTime>
<originCountry code="" name=""/>
<destinationCountry code="" name=""/>
<signatory></signatory>
<statuses>
<status code=" " description="" eventDate="" eventTime=""
depotName=""/>
</statuses>
</connote>
</connotes>
</tracking>
filling
tracking connotes Main tag.
connotes connote Block tag. Contains information about
tracked items. May contain multiple
tags <connote>.
connote statusId Block tag. Contains information about
number the statuses of one tracked invoice
reference
partnerConnote
originDepotName
collectionDate
deliveryTown
deliveryDate
deliveryTime
23
originCountry
destinationCountry
signatory
statuses
statusId yes String tag. Indicates the current state
of transportation.
Possible values:
0 - The waybill does not exist or has
not yet been transferred to TMM for
transportation
1 - Difficulties arose during
transportation.
2 - The shipment is in transit
3 - Transport completed, shipment
delivered
4- Transport completed, delivery did
not take place.
number yes String tag. The number of the TMM
invoice that was tracked.
reference no String tag. Shows the sender's marks
from the invoice, if any.
partnerConnote no String tag. Invoce number of the
partner who took part in the
transportation of the cargo.
originDepotName yes String tag. Sender's depot.
collectionDate yes String tag. Pick up date of the
shipment.
deliveryTown yes String tag. City of destination of
departure.
deliveryDate no String tag. Delivery date.
deliveryTime no String tag. Time of delivery.
originCountry code String tag. Indicates the country of
name the sender.
code yes The originCountry tag attribute.
Sender country code. Specified in the
name yes The originCountry tag attribute.
Sender country name
destinationCountry code yes String tag.
name
code yes The originCountry tag attribute.
Recipient country code. Specified in
the format ISO 3166-1 Alpha-2.
name yes The originCountry tag attribute.
Sender country name
signatory no String tag. Name of the customer
who received the shipment upon
delivery
statuses status Block tag. Contains shipment
statuses.
status code String tag. Contains status
description information.
24
eventDate
eventTime
depotName
code yes Status tag attribute. Contains status
code (см. перечень статусов).
description yes Status tag attribute. Contains a
description of the status (см.
перечень статусов).
eventDate yes Status tag attribute. Contains the
status date. Indicated in the format
YYYY-MM-DD.
eventTime yes Status tag attribute. Contains status
time. Indicated in the format HH-
MM-SS.
depotName yes
Status tag attribute. Contains the
name of the depot in which the
status was assigned.
Receiving the last (current) status of a shipment

The function is designed to get the last (current) status of the shipment.
Group tracking requires multiple tags <number> and/or <reference>,
but not more than 50.
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Tracking/GetLastStatusInfo
Method: POST
Format: XML
<tracking>
<sender account="" countryCode=" "/>
<connotes>
<number></number>
</connotes>
<translation countryCode="GB"/>
</tracking>
tracking Main tag.

sender account String tag. Contains information
countryCode about the client number and
25
country of the sender
account no Sender tag attribute. Contains the
sender's TMM client number
countryCode no Sender tag attribute. Contains the
country code of the sender.
1 Alpha-2
connotes number Block tag. May contain multiple
reference tags <number> and <reference>
number no String tag. Contains the number of
the TMM invoice to be tracked.
reference no String tag. Contains the sender's
marks (internal number of the
order, project, etc.) by which you
want to track the invoice.
translation countryCode String tag. Determines in what
language the answer will be
displayed.
countryCode yes Translation tag attribute. Country
code, the language of which is
selected to display the response to
the request. Specified in the
Available options: GB-English, RU-
Russian, UA-Ukrainian, PL-Polish

Response structure:
Format: XML

<tracking>
<connotes>
<connote>
<number></number>
<status code=" " description="" eventDate="" eventTime="" depotName=""/>
</connote>
</connotes>
</tracking>
filling
tracking connotes Main tag.
tracked shipments. May contain
multiple tags <connote>.
26
connote number Block tag. Contains information on
the statuses of one tracked invoice
number yes String tag. Contains the number of
the TMM invoice that was tracked
status code
description String tag. Contains status
eventDate information.
eventTime
depotName
code yes Status tag attribute. Contains status
code (см. перечень статусов).
description yes Status tag attribute. Contains a
description of the status (см.
перечень статусов).
eventDate yes Status tag attribute. Contains the
status date. Indicated in the format
YYYY-MM-DD.
eventTime yes Status tag attribute. Contains status
time. Indicated in the format HH-
MM-SS.
depotName yes Status tag attribute. Contains the
name of the depot in which the
status was assigned.
Getting the current status of a shipment

The function is designed to get the current state of shipment transportation.
Group tracking requires multiple tags <number>, but not more than 50.
Request structure:
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Tracking/GetShortStatusInfo
Method: POST
Format: XML
<tracking>
<connotes>
<number></number>
</connotes>
</tracking>
filling
tracking Main tag.
connotes number Block tag. May contain multiple tags
27
<number> и <reference>
number yes String tag. Contains the number of
the TMM invoice to be tracked.

Response structure:
Format: XML

<tracking>
<connotes>
<connote number="" statusId=""/>
</connotes>
</tracking>
filling
tracking Main tag.
tracked shipments. May contain
multiple tags <number>.
connote number String tag. Contains information
statusId about the tracked item.
number yes The connote tag attribute. TMM
invoice number tracked
statusId yes The connote tag attribute. Indicates
the current state of transportation.
Possible values:
0 - The waybill does not exist or has
not yet been transferred to TMM for
transportation
1 - Difficulties arose during
transportation.
2 - The shipment is in transit
3 - Transport completed, shipment
delivered
4- Transportation completed, delivery
did not take place.
28
Error codes
Getting information about an error
The function is used to get a description of the error code.
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/Errors/{ID}
Method: GET
Where,
{ID} – error code
Response structure:
Format: XML

<error>
<id></id>
<description>
<translation countryCode="" value=""/>
</description>
</error>
Where,
filling
error id Main tag
description
id yes String tag. Contains an error code.
description translation Block tag. Contains information about
the meaning of the error in different
languages. May contain multiple tags
translation
translation countryCode String tag. Contains information
value about the meaning of the error in one
language.
countryCode yes Translation tag attribute. Contains
the country code of the translation.
1 Alpha-2
value yes
Error value
Getting the error reference

The function is used to get the error reference.
29
URL: http://api.tmm-express.com/{environment}/hs/WebsiteApis/ErrorsDictionary/{CountyCode}
Method: GET
Where,
{CountyCode} - country code in the format ISO 3166-1 Alpha-2, which indicates in which translation to
give errors, if there is no translation for the specified country, then the Russian translation is given
Структура ответа:
Format: XML

<errors>
<error code="" value=""/>
</errors>
Where,
errors Main tag. May contain multiple

tags error
error code String tag. Contains a description
value of the error
code yes The error tag attribute. Contains
an error code
value yes The error tag attribute. Contains a
description of the error.
30
Supplements
List of available Products, Services and additional options
List of available Products

Name Encoding Description
Documents DOX
Not documents NonDocuments
List of Services
Domestic Express DD Standard delivery of parcels and documents within
the country, the minimum transportation period is
1-2 business days, the maximum is 1-5 business
days.
Доставка до 9:00 9D Premium service for the delivery of documents and
parcels on the next working day until 9:00 within the
country.
parcels the next working day until 10:00 within the
country.
parcels on the next business day until 12:00 within
the country.
parcels on the next working day until 18:00 within
the country
Доставка в субботу SD Delivery on Saturday of goods within the country.
Air Express AE International door-to-door delivery of documents
and parcels worth up to € 5400 by air.
Road Express RE International door-to-door delivery of goods by
road. Flights are operated on schedule.
E-commerce EC A special service for online stores delivery of goods.
Easy Express EE Door-to-door delivery of goods by air from China,
Israel, Taiwan, Hong Kong, Canada and the USA.
Flights are operated on schedule.
Handling & Clearance HC Service for the delivery of e-commerce goods from
the seller to the customs terminal, with its customs
clearance and release for free circulation.
Special Service SS Non-standard delivery service:
• If the terms of the standard service are not
satisfied
• The need for temperature control
• The need for movers
• Delivery on weekends
• Shipment dimensions exceed the allowable for
standard services
• Calling a courier at a specific time or outside
working hours
31
• Separate machine
• Packaging
• Oversized cargo
Freight FR International non-standard delivery service:
• If the terms of the standard service are not
satisfied
• The need for temperature control
• The size of the shipment exceeds the limits for the
region
• If there is no delivery to the desired country / city
by standard services
• Delivery of dangerous goods
• Delivery of some goods (food, drinks, seeds,
cosmetics ...) if their transportation by standard
service to a specific country is prohibited.
Door to Warehouse DW Special service for delivering parcels from door to
warehouse.
Warehouse to Door WD Special delivery service for parcels from warehouse
to door.
Warehouse to Warehouse WW Special delivery service for parcels from to the
warehouse.
List of Additional Options:

Cash on delivery COD Cash payment for goods upon delivery.
Has an additional parameter costEstimate. Example
of application in a request:
<option>
<code>COD</code>
<costEstimate currencyCode=" UAH" value="1000"/>>
</option>
Where, currencyCode – currency code, value – amount
of money.
INS Cargo insurance.
Insurance Has an additional parameter costEstimate.
Application example in a request:
<option>
<code>INS</code>
<costEstimate currencyCode=" UAH" value="1000"/>>
</option>
Where, currencyCode – currency code, value –
insured value of the shipment.
ITLL (increased degree of ITL Compensation for loss or damage to cargo
responsibility) transported from / to Ukraine. Does not apply to
items of a documentary nature.
The service is mandatory when sending parcels with
a value not exceeding 5,000 euros.
Pallet delivery EP Delivery of goods consolidated on euro pallets (1.2m
* 0.8m * maximum height 1.5m). One waybill no
more than six pallets. The weight of one pallet is not
more than 500 kg.
Доставка лично в руки PTR The shipment is handed over only to the recipient
that is indicated in the delivery invoice identity
32
cards.
Delivery to the door DD Delivery to the door. This option applies to services
that deliver to the warehouse by default. for
instance: Handling & Clearance
Перечень статусов отправлений

Statuses Description Final
encoding
AA Non-existent invoice yes
AN There is no way to get to the client's territory no
AP Delayed, awaiting payment no
BSC delivery date changed at the request of the client no
BW Delivery delay due to weather conditions no
CA Delivery address changed no
CD The shipment was destroyed at the request of the client yes
CO The company is closed no
CR The recipient refused delivery. no
CRA Refusal to receive the goods - there is no person responsible for signing no
the receipt
CRC Refusal, incorrect / incomplete contact details no
CRD Refusal to receive cargo - cargo is damaged no
CRE Refusal to receive the goods - the recipient cannot accept the shipment no
CRF Refusal, first wanted to inspect the contents no
CRI Refusal to receive cargo - do not want to accept incomplete delivery no
CRL Refusal to receive cargo - late delivery no
CRN Refusal, the client was not informed about the delivery no
CRO Refusal to receive cargo - did not order no
CRP Refusal to receive cargo - no customs documentation no
CRT Refusal to receive cargo - payment terms are not satisfied no
CW Verified weight and dimensions of cargo no
CX The departure was directed on the wrong route no
DB Cargo documents have been handed over to the consignee no
DD Parcel delivered damaged yes
DG Dangerous cargo no
DH The cargo arrived at the warehouse no
DM Shipment delivered, customer claims some content is missing yes
DN Shipment delivered to neighbor yes
DO the shipment is damaged - the cause of the damage is unknown no
DQ Delay in delivery, waiting for the client no
DS Delayed delivery no
DU shipment is damaged, awaiting instructions from the sender no
DV The content of the shipment does not match the declared no
EDA expected date of arrival of the cargo at the transit depot no
EDC estimated pick-up date no
EDD expected date of shipment no
FD shipment damaged no
HB The shipment was handed over to the recipient for further processing yes
33
HI Placed for storage under customs control no
HM There are no supporting documents no
HO The company is closed, holiday no
HP To be in the office at the request of the client no
HW Cargo in the warehouse no
IC Detained by customs for inspection no
IG Content requires government inspection no
IR Received at destination no
IRP Received at partner's destination no
IS Received at transit point no
LAA Flight delay due to a reason caused by government authorities no
LAB Flight delay no
LAC Flight delay no
LAI Flight delay no
LAL Flight delay no
LAW Flight delay no
LC The location of the shipment has not been established yes
LCP Part of the shipment is lost yes
LDA Flight delay due to a reason caused by government authorities no
LDC Flight delay, congestion / traffic restriction no
LDI Flight delay - strike no
LDL Flight delay no
LDW Flight delay, bad weather conditions no
LM The location of the shipment has not been established no
LP Partial delivery no
LXB Flight delay, aircraft / car breakdown no
LXC Flight cancellation, traffic jam / traffic restriction no
LXI Flight delay, aircraft / car breakdown no
LXL Flight cancellation no
LXW Flight cancellation due to difficult weather conditions no
MC The departure was directed on the wrong route no
MD The location of the shipment has not been established no
MLO Not shipped, lack of space in the car no
MR The departure was directed on the wrong route no
MT Content is stolen or lost no
NH Not at home at the time of delivery no
NR Shipment not received no
NT Not enough time for delivery no
NTT Not enough time for delivery, traffic jam no
OD The item has been sent for delivery no
OF The shipment has been handed over for further transportation to the no
destination
OI Incorrect information in the accompanying documentation no
OK The shipment was delivered to the recipient yes
OR There are no originals of accompanying documents no
OS Cargo sent no
OU In the delivery area no
PA The shipment was sent by mail yes
34
PBC Transportation paid by credit card no
PDA Delivery is agreed with the recipient no
PL The shipment was received at the parcel terminal yes
PM The shipment was sent by mail - delivery confirmation cannot be yes
received
PNA Customer phone is not answering no
PR Partial shipment arrived at destination no
PU The shipment is accepted for transportation no
RC The shipment has been released from customs control. no
RO Item returned to sender yes
RPL Picked up by courier from the parcel terminal no
RTS cargo returned to the sender yes
SG Consignment seized by state services yes
TR Shipment physically scanned no
TS Sent from the depot no
TSR Submitted for return to sender no
UA The shipment could not be sent due to an incomplete delivery address no
UC The shipment contains prohibited goods for carriage no
UNR The collection of the shipment is not possible. Cargo is not ready no
UP The documents for the cargo are not executed correctly. no
VB Delayed delivery, vehicle breakdown no
VC Verbal confirmation of delivery yes
WA Delay, correct delivery address expected no
WAC the shipment was not delivered due to incorrect recipient data no
WAD the shipment was not delivered due to incorrect recipient data no
WAH the shipment was not delivered due to incorrect recipient data no
WAM the shipment was not delivered due to incorrect recipient data no
WAT the shipment was not delivered due to incorrect recipient data no
WD Delivered to the wrong address no
WE The company is closed for the weekend no
35
Invoice form
36
Shape of stickers
37
Proforma Invoice Form
38

API Docs ENG

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Docs ENG

Uploaded by

Copyright:

Available Formats

2020

TMM EXPRESS | Версия от 01.04.2020

API request format

The client The client fills in

The client hands

connote getNumber Main tag

recipient's phone number.

thirdParty companyName Block tag. Contains information

If successful, the response code 204.

Structure of response in case of error:

<?xml version="1.0" encoding="utf-8"?>

editConnote error Main tag.

Example of a request for a specific location:

Example of a request for all points of departure:

Structure of the response in case of an error:

<?xml version="1.0" encoding="utf-8"?>

pickupOrder client Main tag

<?xml version="1.0" encoding="utf-8"?>

pickupOrder number Main tag

In case of error, the response code 200.

<?xml version="1.0" encoding="utf-8"?>

pickupOrder errors Main tag

tracking Main tag.

If successful, the response code 200.

<?xml version="1.0" encoding="utf-8"?>

Receiving the last (current) status of a shipment

tracking Main tag.

If successful, the response code 200.

<?xml version="1.0" encoding="utf-8"?>

Getting the current status of a shipment

If successful, the response code 200.

<?xml version="1.0" encoding="utf-8"?>

Request body is empty

<?xml version="1.0" encoding="utf-8"?>

Getting the error reference

Request body is empty

<?xml version="1.0" encoding="utf-8"?>

errors Main tag. May contain multiple

List of available Products, Services and additional options

List of available Products

List of Additional Options:

Перечень статусов отправлений

You might also like