General Information
Test of general documentation and examples of rest api!
Detailed Documentation (including code samples)
Authentication
- HTTP Authentication, scheme: basic
shipments
creates a shipment
Code samples
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.post 'https://api.test.letmeship.com/v1/shipments',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.post('https://api.test.letmeship.com/v1/shipments', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /shipments
Body parameter
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"service": {
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"labelOptions": "DEFAULT",
"shipmentNotification": {
"addtionalCarrierNotification": {
"email": "string",
"mobilePhone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
}
},
"trackingNotification": {
"deliveryNotification": true,
"problemNotification": true,
"emails": [
"string"
],
"notificationText": "string"
},
"recipientNotification": {
"notificationText": "string",
"emails": [
"string"
]
}
},
"labelEmail": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| body | body | CreateShipmentRequest | true | A shipment can be created. |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"service": {
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"shipmentId": 0,
"customerNumber": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful shipment creation | CreateShipmentResponse |
| 400 | Bad Request | bad input parameter | None |
| 500 | Internal Server Error | internal error | None |
returns a list of all shipments since last shipment.
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/shipments',
params: {
'lastshipmentid' => 'integer(int64)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/shipments', params={
'lastshipmentid': '0'
}, headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments?lastshipmentid=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /shipments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| lastshipmentid | query | integer(int64) | true | Id of the last shipment |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
[
{
"customerId": 0,
"lastShipmentId": 0,
"restRowCount": 0,
"shipmentList": [
{
"shipmentId": 0,
"bookingState": "BOOKING_IN_PROGRESS",
"orderer": "string",
"createdDate": "string",
"service": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | returns shipment data for various shipments | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [GetShipmentsResponse] | false | none | none |
| »»»»» company | string | false | none | company name. Required for Standard services |
| »»» parcelList | [ParcelItem] | true | none | none |
returns the shipment information
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/shipments/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/shipments/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /shipments/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| id | path | integer(int64) | true | Id of the shipment |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
{
"id": 0,
"trackingData": {
"carrier": "Aramex",
"awbNumber": "string",
"registrationTime": "string",
"expectedDeliveryTime": "string",
"serviceType": "EXPRESS",
"sender": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"consignee": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryAddress": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"awbNumber": "string"
}
],
"trackingEventList": [
{
"dateTime": "string",
"trackingStatus": "string",
"location": "string",
"description": "string",
"lmsTrackingStatus": "UNKNOWN"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | shipment information | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
| 404 | Not Found | not found | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » id | integer(int64) | false | none | none |
| »»» company | string | false | none | company name. Required for Standard services |
cancels a shipment
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.delete 'https://api.test.letmeship.com/v1/shipments/{id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.delete('https://api.test.letmeship.com/v1/shipments/{id}', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
DELETE /shipments/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| id | path | integer(int64) | true | Comma separated list of shipment ids |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
{
"shipmentId": 0,
"cancellationState": "SUCCESSFUL",
"details": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful shipment cancellation | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » shipmentId | integer(int64) | true | none | none |
returns the shipment related documents. Eg. label
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/shipments/{id}/documents',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/shipments/{id}/documents', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments/{id}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /shipments/{id}/documents
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| id | path | integer(int64) | true | Id of the shipment |
| type | query | array[string] | false | Define list of document types to return |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
| type | LABEL |
| type | MANIFEST |
| type | SUMMARY |
| type | CUSTOMS |
| type | ENTRY_DOCUMENTS |
| type | PICKUP_PROTOCOL |
| type | PRO_FORMA_INVOICE |
| type | OTHER |
| type | SIGNATURE_IMAGE |
Example responses
200 Response
{
"shipmentId": 0,
"documents": [
{
"mimeType": "string",
"status": "READY",
"type": "LABEL",
"size": "DEFAULT",
"data": "string",
"dataEncoded": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | the result of the documents request | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » shipmentId | integer(int64) | false | none | none |
| » documents | [Document] | false | none | none |
returns tracking data for one shipment
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/tracking',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/tracking', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/tracking");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /tracking
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| shipmentid | query | integer(int64) | false | Id of the shipment |
| carrier | query | Carriers | false | carrier name |
| awb | query | string | false | awb number |
| pod | query | boolean | false | flag to include POD document if possible |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
| carrier | Aramex |
| carrier | Atlas |
| carrier | BestGlobalLogistics |
| carrier | Boxtal |
| carrier | Bpost |
| carrier | CHPost |
| carrier | Chronopost |
| carrier | Colissimo |
| carrier | Correos |
| carrier | CoursierPaname |
| carrier | Dachser |
| carrier | DerKurier |
| carrier | DerKurierInternational |
| carrier | DHL |
| carrier | DHLEuropack |
| carrier | DHLS |
| carrier | DHLWeltpaket |
| carrier | DHLFreight |
| carrier | DieFunkpiloten |
| carrier | DPD |
| carrier | DSV |
| carrier | DZAirConsulting |
| carrier | ECUWorldwide |
| carrier | EFExpress |
| carrier | FahrlogistikWaechter |
| carrier | FedEx |
| carrier | Flexpress |
| carrier | GEL |
| carrier | GeldersForwarding |
| carrier | Geodis |
| carrier | GLS |
| carrier | GO |
| carrier | GondrandTraffic |
| carrier | GruberLogistics |
| carrier | HacasTransport |
| carrier | Hellmann |
| carrier | HellmannNightstar |
| carrier | Hermes |
| carrier | HSIntertrans |
| carrier | Iloxx |
| carrier | INTIME |
| carrier | Intercom |
| carrier | Jumingo |
| carrier | KuehneundNagel |
| carrier | LetMeShip |
| carrier | LINEX |
| carrier | LinkUp |
| carrier | M3 |
| carrier | Marway |
| carrier | MBE |
| carrier | Midway |
| carrier | MITXELENAGARRAIOAK |
| carrier | Nacex |
| carrier | NikolaiLiebkeLogistics |
| carrier | NTGRoad |
| carrier | OBC |
| carrier | OFCShipping |
| carrier | ORCA |
| carrier | Packlink |
| carrier | PlanningScanLogistics |
| carrier | Planzer |
| carrier | PostAT |
| carrier | PostNL |
| carrier | Redline |
| carrier | SACOGROUPAIR |
| carrier | Saloodo |
| carrier | SamedayInternationalRotterdam |
| carrier | SameDayCarrier |
| carrier | SamedayLogistics |
| carrier | Schenker |
| carrier | SchwerdtfegerTransport |
| carrier | SEUR |
| carrier | Shipcloud |
| carrier | SITRASpedition |
| carrier | SkyNet |
| carrier | Sodexi |
| carrier | Sovereign |
| carrier | Special |
| carrier | Speditionsagentur |
| carrier | Swisspost |
| carrier | TimeMatters |
| carrier | Tipsa |
| carrier | TNT |
| carrier | TNTNightstar |
| carrier | Transglobal |
| carrier | Transmove |
| carrier | Transoflex |
| carrier | TransportUrgent |
| carrier | Upela |
| carrier | UPS |
| carrier | Venlogistics |
| carrier | WuerthLogistik |
Example responses
200 Response
[
{
"carrier": "Aramex",
"awbNumber": "string",
"shipmentId": 0,
"currentTrackingStatus": "string",
"lmsTrackingStatus": "UNKNOWN",
"currentStatusTime": "string",
"currentStatusLocation": "string",
"pod": {
"mimeType": "string",
"status": "READY",
"type": "LABEL",
"size": "DEFAULT",
"data": "string",
"dataEncoded": "string"
},
"trackingEventList": [
{
"dateTime": "string",
"trackingStatus": "string",
"location": "string",
"description": "string",
"lmsTrackingStatus": "UNKNOWN"
}
]
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | returns tracking data for one shipment | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [TrackingDataResponseBody] | false | none | none |
| » trackingEventList | [TrackingEvent] | true | none | List of past tracking events |
returns the state of one or multiple shipments
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/shipments/{id}/states',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/shipments/{id}/states', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/shipments/{id}/states");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /shipments/{id}/states
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| id | path | integer(int64) | true | none |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
[
{
"shipmentId": 0,
"shipmentState": "BOOKING_IN_PROGRESS",
"labelState": "READY",
"entryDocumentsState": "READY",
"noteType": "NS",
"text": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | the result of the shipmentState request | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ShipmentStateResponse] | false | none | none |
returns a listing of the available services on the route for specified shipment
Code samples
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.post 'https://api.test.letmeship.com/v1/available',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.post('https://api.test.letmeship.com/v1/available', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/available");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /available
Body parameter
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"excludedCarriers": [
"Aramex"
],
"includedCarriers": [
"Aramex"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| body | body | AvailableServicesRequestBody | true | returns a listing of the available services on the route |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
{
"serviceList": [
{
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | the result of the cancelShipment request | AvailableServicesResponseBody |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
returns carrier related documents
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.get 'https://api.test.letmeship.com/v1/pickups',
params: {
'carrier' => '[Carriers](#schemacarriers)'
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.get('https://api.test.letmeship.com/v1/pickups', params={
'carrier': 'Aramex'
}, headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/pickups?carrier=Aramex");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /pickups
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| carrier | query | Carriers | true | carrier name |
| date | query | string | false | date of pickup |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
| carrier | Aramex |
| carrier | Atlas |
| carrier | BestGlobalLogistics |
| carrier | Boxtal |
| carrier | Bpost |
| carrier | CHPost |
| carrier | Chronopost |
| carrier | Colissimo |
| carrier | Correos |
| carrier | CoursierPaname |
| carrier | Dachser |
| carrier | DerKurier |
| carrier | DerKurierInternational |
| carrier | DHL |
| carrier | DHLEuropack |
| carrier | DHLS |
| carrier | DHLWeltpaket |
| carrier | DHLFreight |
| carrier | DieFunkpiloten |
| carrier | DPD |
| carrier | DSV |
| carrier | DZAirConsulting |
| carrier | ECUWorldwide |
| carrier | EFExpress |
| carrier | FahrlogistikWaechter |
| carrier | FedEx |
| carrier | Flexpress |
| carrier | GEL |
| carrier | GeldersForwarding |
| carrier | Geodis |
| carrier | GLS |
| carrier | GO |
| carrier | GondrandTraffic |
| carrier | GruberLogistics |
| carrier | HacasTransport |
| carrier | Hellmann |
| carrier | HellmannNightstar |
| carrier | Hermes |
| carrier | HSIntertrans |
| carrier | Iloxx |
| carrier | INTIME |
| carrier | Intercom |
| carrier | Jumingo |
| carrier | KuehneundNagel |
| carrier | LetMeShip |
| carrier | LINEX |
| carrier | LinkUp |
| carrier | M3 |
| carrier | Marway |
| carrier | MBE |
| carrier | Midway |
| carrier | MITXELENAGARRAIOAK |
| carrier | Nacex |
| carrier | NikolaiLiebkeLogistics |
| carrier | NTGRoad |
| carrier | OBC |
| carrier | OFCShipping |
| carrier | ORCA |
| carrier | Packlink |
| carrier | PlanningScanLogistics |
| carrier | Planzer |
| carrier | PostAT |
| carrier | PostNL |
| carrier | Redline |
| carrier | SACOGROUPAIR |
| carrier | Saloodo |
| carrier | SamedayInternationalRotterdam |
| carrier | SameDayCarrier |
| carrier | SamedayLogistics |
| carrier | Schenker |
| carrier | SchwerdtfegerTransport |
| carrier | SEUR |
| carrier | Shipcloud |
| carrier | SITRASpedition |
| carrier | SkyNet |
| carrier | Sodexi |
| carrier | Sovereign |
| carrier | Special |
| carrier | Speditionsagentur |
| carrier | Swisspost |
| carrier | TimeMatters |
| carrier | Tipsa |
| carrier | TNT |
| carrier | TNTNightstar |
| carrier | Transglobal |
| carrier | Transmove |
| carrier | Transoflex |
| carrier | TransportUrgent |
| carrier | Upela |
| carrier | UPS |
| carrier | Venlogistics |
| carrier | WuerthLogistik |
Example responses
200 Response
[
{
"mimeType": "string",
"status": "READY",
"type": "LABEL",
"size": "DEFAULT",
"data": "string",
"dataEncoded": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | returns carrier related documents | Inline |
| 400 | Bad Request | bad input parameter | None |
| 403 | Forbidden | authentication problem | None |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Document] | false | none | none |
orders
creates a shipment order
Code samples
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Access-Control-Allow-Origin' => 'string',
'Lms-Region' => 'DE'
}
result = RestClient.post 'https://api.test.letmeship.com/v1/orders',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Access-Control-Allow-Origin': 'string',
'Lms-Region': 'DE'
}
r = requests.post('https://api.test.letmeship.com/v1/orders', headers = headers)
print(r.json())
URL obj = new URL("https://api.test.letmeship.com/v1/orders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
POST /orders
Body parameter
{
"shipmentOrders": [
{
"identifier": "string",
"pickupAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"deliveryAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"orderDetails": {
"shipmentType": "PARCEL",
"goodsValue": 0,
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"contentDescription": "string",
"additionalHandling": false,
"customReferenceCodes": [],
"items": {
"label": "string",
"value": "string"
},
"defaultReferenceCode": "string"
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Access-Control-Allow-Origin | header | string | true | none |
| Lms-Region | header | LmsRegions | false | The field is used for different regions/domains. If not specified, DE is used. |
| body | body | CreateShipmentOrdersRequest | true | A shipment can be created. |
Enumerated Values
| Parameter | Value |
|---|---|
| Lms-Region | DE |
| Lms-Region | FR |
| Lms-Region | CH |
| Lms-Region | NL |
| Lms-Region | AT |
| Lms-Region | BE |
| Lms-Region | ES |
Example responses
200 Response
{
"identifiers": [
"string"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful shipment creation | CreateShipmentOrdersResponse |
| 400 | Bad Request | bad input parameter | None |
| 500 | Internal Server Error | internal error | None |
Schemas
LmsRegions
"DE"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | DE |
| anonymous | FR |
| anonymous | CH |
| anonymous | NL |
| anonymous | AT |
| anonymous | BE |
| anonymous | ES |
CreateShipmentResponse
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"service": {
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"shipmentId": 0,
"customerNumber": 0
}
Properties
None
GetShipmentsResponse
{
"customerId": 0,
"lastShipmentId": 0,
"restRowCount": 0,
"shipmentList": [
{
"shipmentId": 0,
"bookingState": "BOOKING_IN_PROGRESS",
"orderer": "string",
"createdDate": "string",
"service": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customerId | integer(int64) | true | none | Internal number of client (orderer) from LetMeShip |
| lastShipmentId | integer(int64) | true | none | Last internal booking reference number from LetMeShip. Taken from request |
| restRowCount | integer(int64) | true | none | none |
| shipmentList | [ShipmentInfo] | true | none | none |
ShipmentInfo
{
"shipmentId": 0,
"bookingState": "BOOKING_IN_PROGRESS",
"orderer": "string",
"createdDate": "string",
"service": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| shipmentId | integer(int64) | true | none | Internal booking reference number from LetMeShip |
ShipmentStateResponse
{
"shipmentId": 0,
"shipmentState": "BOOKING_IN_PROGRESS",
"labelState": "READY",
"entryDocumentsState": "READY",
"noteType": "NS",
"text": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| shipmentId | integer(int64) | false | none | Shipment identifier taken from request |
| shipmentState | string | true | none | Shipment state in booking process. |
Enumerated Values
| Property | Value |
|---|---|
| shipmentState | BOOKING_IN_PROGRESS |
| shipmentState | BOOKING_FINISHED |
| shipmentState | LOCKED |
| shipmentState | CANCEL_REQUESTED |
| shipmentState | CANCELLED |
| shipmentState | NOT_FOUND |
CreateShipmentRequest
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"service": {
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"labelOptions": "DEFAULT",
"shipmentNotification": {
"addtionalCarrierNotification": {
"email": "string",
"mobilePhone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
}
},
"trackingNotification": {
"deliveryNotification": true,
"problemNotification": true,
"emails": [
"string"
],
"notificationText": "string"
},
"recipientNotification": {
"notificationText": "string",
"emails": [
"string"
]
}
},
"labelEmail": true
}
Properties
None
AvailableServicesRequestBody
{
"pickupInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"deliveryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryInfo": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"shipmentDetails": {
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
},
"excludedCarriers": [
"Aramex"
],
"includedCarriers": [
"Aramex"
]
}
Properties
None
AvailableServicesResponseBody
{
"serviceList": [
{
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| serviceList | [ServiceDetails] | false | none | none |
PriceInfo
{
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
In response: contains information about shipment price. In request: when you resend the totalPrice from the price information you received in /availalble response, LetMeShip will check and confirm it.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| realWeight | number | false | none | Real weight of the shipment. Real weight is calculated as a sum of weights of all parcels you defined in request. Mass unit is kilogram (kg). |
| dimensionalWeight | number | false | none | Dimensional weight of the shipment. Dimensional weight is calculated for parcels which are lightweight in proportion to their volume. Mass unit is kilogram (kg). |
| billingWeight | number | false | none | Billing weight of the shipment. Billing weight is a maximum of real and dimensional weight This is the weight the customer is billed for. Mass unit is kilogram (kg). |
| basePrice | number | false | none | Price from price list without surcharges (list price for transport) without VAT. |
| discountedPrice | number | false | none | Discounted price. Presented only if it differs from base price. |
| netPrice | number | false | none | none |
| totalVat | number | false | none | Total VAT price |
| totalPrice | number | false | none | Total price. |
| surcharges | [Surcharge] | false | none | list of surcharges |
Surcharge
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | Surcharge name. |
| amount | number | true | none | Amount of the surcharge |
| percentage | number | false | none | Percentage of the surcharge in discounted price (or base price if discounted price not presented). |
CancellationStateType
"SUCCESSFUL"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | SUCCESSFUL |
| anonymous | NOT_SUCCESSFUL |
ShipmentStateType
"BOOKING_IN_PROGRESS"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | BOOKING_IN_PROGRESS |
| anonymous | BOOKING_FINISHED |
| anonymous | LOCKED |
| anonymous | CANCEL_REQUESTED |
| anonymous | CANCELLED |
| anonymous | NOT_FOUND |
Carriers
"Aramex"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Aramex |
| anonymous | Atlas |
| anonymous | BestGlobalLogistics |
| anonymous | Boxtal |
| anonymous | Bpost |
| anonymous | CHPost |
| anonymous | Chronopost |
| anonymous | Colissimo |
| anonymous | Correos |
| anonymous | CoursierPaname |
| anonymous | Dachser |
| anonymous | DerKurier |
| anonymous | DerKurierInternational |
| anonymous | DHL |
| anonymous | DHLEuropack |
| anonymous | DHLS |
| anonymous | DHLWeltpaket |
| anonymous | DHLFreight |
| anonymous | DieFunkpiloten |
| anonymous | DPD |
| anonymous | DSV |
| anonymous | DZAirConsulting |
| anonymous | ECUWorldwide |
| anonymous | EFExpress |
| anonymous | FahrlogistikWaechter |
| anonymous | FedEx |
| anonymous | Flexpress |
| anonymous | GEL |
| anonymous | GeldersForwarding |
| anonymous | Geodis |
| anonymous | GLS |
| anonymous | GO |
| anonymous | GondrandTraffic |
| anonymous | GruberLogistics |
| anonymous | HacasTransport |
| anonymous | Hellmann |
| anonymous | HellmannNightstar |
| anonymous | Hermes |
| anonymous | HSIntertrans |
| anonymous | Iloxx |
| anonymous | INTIME |
| anonymous | Intercom |
| anonymous | Jumingo |
| anonymous | KuehneundNagel |
| anonymous | LetMeShip |
| anonymous | LINEX |
| anonymous | LinkUp |
| anonymous | M3 |
| anonymous | Marway |
| anonymous | MBE |
| anonymous | Midway |
| anonymous | MITXELENAGARRAIOAK |
| anonymous | Nacex |
| anonymous | NikolaiLiebkeLogistics |
| anonymous | NTGRoad |
| anonymous | OBC |
| anonymous | OFCShipping |
| anonymous | ORCA |
| anonymous | Packlink |
| anonymous | PlanningScanLogistics |
| anonymous | Planzer |
| anonymous | PostAT |
| anonymous | PostNL |
| anonymous | Redline |
| anonymous | SACOGROUPAIR |
| anonymous | Saloodo |
| anonymous | SamedayInternationalRotterdam |
| anonymous | SameDayCarrier |
| anonymous | SamedayLogistics |
| anonymous | Schenker |
| anonymous | SchwerdtfegerTransport |
| anonymous | SEUR |
| anonymous | Shipcloud |
| anonymous | SITRASpedition |
| anonymous | SkyNet |
| anonymous | Sodexi |
| anonymous | Sovereign |
| anonymous | Special |
| anonymous | Speditionsagentur |
| anonymous | Swisspost |
| anonymous | TimeMatters |
| anonymous | Tipsa |
| anonymous | TNT |
| anonymous | TNTNightstar |
| anonymous | Transglobal |
| anonymous | Transmove |
| anonymous | Transoflex |
| anonymous | TransportUrgent |
| anonymous | Upela |
| anonymous | UPS |
| anonymous | Venlogistics |
| anonymous | WuerthLogistik |
DocumentTypes
"LABEL"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | LABEL |
| anonymous | MANIFEST |
| anonymous | SUMMARY |
| anonymous | CUSTOMS |
| anonymous | ENTRY_DOCUMENTS |
| anonymous | PICKUP_PROTOCOL |
| anonymous | PRO_FORMA_INVOICE |
| anonymous | OTHER |
| anonymous | SIGNATURE_IMAGE |
DocumentStatuses
"READY"
document or label state. If ready, can be downloaded using appropriate method
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | document or label state. If ready, can be downloaded using appropriate method |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | READY |
| anonymous | NOT_AVAILABLE |
| anonymous | NOT_READY |
| anonymous | SHIPMENT_CANCELLED |
| anonymous | NO_CONTENT |
Document
{
"mimeType": "string",
"status": "READY",
"type": "LABEL",
"size": "DEFAULT",
"data": "string",
"dataEncoded": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mimeType | string | false | none | none |
TrackingDataResponseBody
{
"carrier": "Aramex",
"awbNumber": "string",
"shipmentId": 0,
"currentTrackingStatus": "string",
"lmsTrackingStatus": "UNKNOWN",
"currentStatusTime": "string",
"currentStatusLocation": "string",
"pod": {
"mimeType": "string",
"status": "READY",
"type": "LABEL",
"size": "DEFAULT",
"data": "string",
"dataEncoded": "string"
},
"trackingEventList": [
{
"dateTime": "string",
"trackingStatus": "string",
"location": "string",
"description": "string",
"lmsTrackingStatus": "UNKNOWN"
}
]
}
Properties
None
TrackingEvent
{
"dateTime": "string",
"trackingStatus": "string",
"location": "string",
"description": "string",
"lmsTrackingStatus": "UNKNOWN"
}
Tracking event detail
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateTime | string | true | none | Tracking event date and time. |
| trackingStatus | string | false | none | none |
| location | string | false | none | Tracking event location. |
| description | string | false | none | Tracking event description. |
LabelSizeType
"DEFAULT"
Defines preferred size of label document. Size in mm.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Defines preferred size of label document. Size in mm. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | DEFAULT |
| anonymous | 100*150 |
TrackingState
"UNKNOWN"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | UNKNOWN |
| anonymous | INFO |
| anonymous | IN_PROGRESS |
| anonymous | PICKED_UP |
| anonymous | IN_PROGRESS_UNKNOWN |
| anonymous | IN_PROGRESS_ON_THE_WAY |
| anonymous | IN_PROGRESS_ON_HOLD |
| anonymous | IN_PROGRESS_DAMAGED |
| anonymous | IN_PROGRESS_NO NEWS |
| anonymous | FINISHED |
| anonymous | DELIVERED |
| anonymous | DELIVERED_OK |
| anonymous | DELIVERED_DAMAGED |
| anonymous | DELIVERED_LATE |
| anonymous | DELIVERED_WITH_REMARK |
| anonymous | FINISHED_WITH_REMARK |
| anonymous | LOST |
| anonymous | RETURNED |
| anonymous | TRACKING_DISABLED |
| anonymous | NO_TRACKING_INFORMATION |
Address
{
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
}
Properties
None
Person
{
"title": "MRS",
"firstname": "string",
"lastname": "string"
}
Properties
None
Title
"MRS"
person title
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | person title |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | MRS |
| anonymous | MR |
| anonymous | MS |
PhoneNumber
{
"phoneNumber": "string",
"phoneNumberPrefix": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| phoneNumber | string | false | none | none |
| phoneNumberPrefix | string | true | none | none |
Contact
{
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
Properties
None
Service
{
"carrierId": "string"
}
Choose the right service and carrier.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| carrierId | string | true | none | none |
ExWorks
{
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
}
Container which holds ExWorks data. Presence of the container flags that ExWorks shipping is requested. 'address' field is required for 'THIRD_PARTY_PAYS' ExWorks type
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountNumber | string | true | none | Account number of party which pays. Required for RECEIVER_PAYS and THIRD_PARTY_PAYS ExWorks types. Must conform to account number format of the carrier used for the shipping |
ExWorksType
"THIRD_PARTY_PAYS"
Defines requested ExWorks type.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Defines requested ExWorks type. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | RECEIVER_PAYS |
| anonymous | THIRD_PARTY_PAYS |
| anonymous | CASH_ON_DELIVERY |
ServiceType
"EXPRESS"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | EXPRESS |
| anonymous | STANDARD |
| anonymous | IMPORT |
| anonymous | STANDARD_IMPORT |
| anonymous | THIRD_COUNTRY |
| anonymous | SAMEDAY |
| anonymous | SPECIAL |
| anonymous | FREIGHT |
TransportType
"EXPRESS"
Type of service used for booking.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Type of service used for booking. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | EXPRESS |
| anonymous | STANDARD |
| anonymous | EXPRESS_PALETTE |
| anonymous | STANDARD_PALETTE |
| anonymous | SAMEDAY |
| anonymous | SPECIAL |
| anonymous | FREIGHT |
ShipmentType
"PARCEL"
Defines content of shipment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Defines content of shipment |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PARCEL |
| anonymous | DOCUMENT |
TariffNumbers
[
"string"
]
Properties
None
DangerousGoods
{
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
}
Container for dangerous goods details of the parcel. Only one parcel can be shipped with dangerous goods definition.
Properties
None
TransportationModeType
"GND"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | GND |
| anonymous | PAX |
| anonymous | CAO |
UnitOfMeasureType
"GRAMM"
Unit of measure.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Unit of measure. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | GRAMM |
| anonymous | KILOGRAMM |
| anonymous | MILLILITER |
DangerousGoodsAccessibilityType
"ACCESSIBLE"
Indicates if the dangerous goods are accessible or inaccessible during delivery
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Indicates if the dangerous goods are accessible or inaccessible during delivery |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | ACCESSIBLE |
| anonymous | INACCESSIBLE |
DangerousGoodsClassType
"Class1"
Class of dangerous goods.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Class of dangerous goods. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Class1 |
| anonymous | Class2 |
| anonymous | Class3 |
| anonymous | Class4 |
| anonymous | Class5 |
| anonymous | Class6 |
| anonymous | Class7 |
| anonymous | Class8 |
| anonymous | Class9 |
DangerousGoodsClassDivisionType
"Class11"
Class division. Related to selected class.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Class division. Related to selected class. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Class11 |
| anonymous | Class12 |
| anonymous | Class13 |
| anonymous | Class14 |
| anonymous | Class15 |
| anonymous | Class16 |
| anonymous | Class21 |
| anonymous | Class22 |
| anonymous | Class23 |
| anonymous | Class41 |
| anonymous | Class42 |
| anonymous | Class43 |
| anonymous | Class51 |
| anonymous | Class52 |
| anonymous | Class61 |
| anonymous | Class62 |
DangerousGoodsRegulationType
"ADR"
Identifies the source of regulation for hazardous commodity data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Identifies the source of regulation for hazardous commodity data. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | ADR |
| anonymous | DOT |
| anonymous | IATA |
| anonymous | ORMD |
CountryCodeType
"AD"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | AD |
| anonymous | AE |
| anonymous | AI |
| anonymous | AF |
| anonymous | AG |
| anonymous | AL |
| anonymous | AM |
| anonymous | AN |
| anonymous | AO |
| anonymous | AQ |
| anonymous | AR |
| anonymous | AS |
| anonymous | AT |
| anonymous | AW |
| anonymous | AU |
| anonymous | AX |
| anonymous | AZ |
| anonymous | BA |
| anonymous | BD |
| anonymous | BE |
| anonymous | BF |
| anonymous | BG |
| anonymous | BH |
| anonymous | BI |
| anonymous | BJ |
| anonymous | BL |
| anonymous | BM |
| anonymous | BN |
| anonymous | BO |
| anonymous | BR |
| anonymous | BS |
| anonymous | BT |
| anonymous | BV |
| anonymous | BW |
| anonymous | BY |
| anonymous | BZ |
| anonymous | CA |
| anonymous | CC |
| anonymous | CD |
| anonymous | CE |
| anonymous | CF |
| anonymous | CG |
| anonymous | CH |
| anonymous | CI |
| anonymous | CK |
| anonymous | CL |
| anonymous | CM |
| anonymous | CN |
| anonymous | CO |
| anonymous | CR |
| anonymous | CV |
| anonymous | CU |
| anonymous | CX |
| anonymous | CY |
| anonymous | CZ |
| anonymous | DE |
| anonymous | DJ |
| anonymous | DK |
| anonymous | DM |
| anonymous | DO |
| anonymous | DZ |
| anonymous | EC |
| anonymous | EE |
| anonymous | EH |
| anonymous | EG |
| anonymous | ER |
| anonymous | ES |
| anonymous | ET |
| anonymous | FI |
| anonymous | FJ |
| anonymous | FK |
| anonymous | FM |
| anonymous | FO |
| anonymous | FR |
| anonymous | GA |
| anonymous | GB |
| anonymous | GD |
| anonymous | GE |
| anonymous | GF |
| anonymous | GG |
| anonymous | GH |
| anonymous | GI |
| anonymous | GL |
| anonymous | GM |
| anonymous | GN |
| anonymous | GP |
| anonymous | GQ |
| anonymous | GR |
| anonymous | GS |
| anonymous | GT |
| anonymous | GW |
| anonymous | GY |
| anonymous | HK |
| anonymous | HM |
| anonymous | HN |
| anonymous | HR |
| anonymous | HT |
| anonymous | HU |
| anonymous | IC |
| anonymous | ID |
| anonymous | IE |
| anonymous | IL |
| anonymous | IM |
| anonymous | IN |
| anonymous | IQ |
| anonymous | IR |
| anonymous | IS |
| anonymous | IT |
| anonymous | JE |
| anonymous | JM |
| anonymous | JO |
| anonymous | JP |
| anonymous | KE |
| anonymous | KH |
| anonymous | KI |
| anonymous | KG |
| anonymous | KM |
| anonymous | KN |
| anonymous | KP |
| anonymous | KR |
| anonymous | KV |
| anonymous | KW |
| anonymous | KY |
| anonymous | KZ |
| anonymous | LA |
| anonymous | LB |
| anonymous | LC |
| anonymous | LI |
| anonymous | LK |
| anonymous | LR |
| anonymous | LS |
| anonymous | LT |
| anonymous | LU |
| anonymous | LV |
| anonymous | LY |
| anonymous | MA |
| anonymous | MC |
| anonymous | MD |
| anonymous | ME |
| anonymous | MF |
| anonymous | MG |
| anonymous | MH |
| anonymous | MK |
| anonymous | ML |
| anonymous | MM |
| anonymous | MN |
| anonymous | MO |
| anonymous | MP |
| anonymous | MQ |
| anonymous | MR |
| anonymous | MS |
| anonymous | MT |
| anonymous | MU |
| anonymous | MV |
| anonymous | MW |
| anonymous | MX |
| anonymous | MY |
| anonymous | MZ |
| anonymous | NA |
| anonymous | NC |
| anonymous | NE |
| anonymous | NF |
| anonymous | NG |
| anonymous | NI |
| anonymous | NL |
| anonymous | NO |
| anonymous | NP |
| anonymous | NR |
| anonymous | NU |
| anonymous | NZ |
| anonymous | OM |
| anonymous | PA |
| anonymous | PE |
| anonymous | PF |
| anonymous | PG |
| anonymous | PH |
| anonymous | PK |
| anonymous | PL |
| anonymous | PM |
| anonymous | PN |
| anonymous | PS |
| anonymous | PT |
| anonymous | PR |
| anonymous | PW |
| anonymous | PY |
| anonymous | QA |
| anonymous | RE |
| anonymous | RO |
| anonymous | RS |
| anonymous | RU |
| anonymous | RW |
| anonymous | SA |
| anonymous | SB |
| anonymous | SC |
| anonymous | SD |
| anonymous | SE |
| anonymous | SI |
| anonymous | SJ |
| anonymous | SH |
| anonymous | SG |
| anonymous | SK |
| anonymous | SL |
| anonymous | SM |
| anonymous | SN |
| anonymous | SO |
| anonymous | SR |
| anonymous | ST |
| anonymous | SV |
| anonymous | SX |
| anonymous | SY |
| anonymous | SZ |
| anonymous | TC |
| anonymous | TD |
| anonymous | TF |
| anonymous | TH |
| anonymous | TJ |
| anonymous | TG |
| anonymous | TK |
| anonymous | TL |
| anonymous | TM |
| anonymous | TN |
| anonymous | TO |
| anonymous | TR |
| anonymous | TT |
| anonymous | TV |
| anonymous | TW |
| anonymous | TZ |
| anonymous | UA |
| anonymous | UG |
| anonymous | UM |
| anonymous | US |
| anonymous | UY |
| anonymous | UZ |
| anonymous | VA |
| anonymous | VC |
| anonymous | VE |
| anonymous | VG |
| anonymous | VI |
| anonymous | VN |
| anonymous | VU |
| anonymous | WF |
| anonymous | WT |
| anonymous | XB |
| anonymous | XC |
| anonymous | XM |
| anonymous | YE |
| anonymous | YT |
| anonymous | ZA |
| anonymous | ZM |
| anonymous | ZW |
ParcelAwb
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"awbNumber": "string"
}
Parcel details
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| height | integer(int32) | true | none | Parcel’s height. Height’s length unit is centimetre (cm). |
| width | integer(int32) | true | none | Parcel’s width. Width’s length unit is centimetre (cm). |
| length | integer(int32) | true | none | Parcel’s length. Length unit is centimetre (cm). |
| weight | number | true | none | Parcel’s weight. Mass unit is kilogram (kg). |
| awbNumber | string | false | none | Parcel AWB number. |
ParcelItem
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| height | integer(int32) | true | none | Parcel’s height. Length unit is centimetre (cm) |
| width | integer(int32) | true | none | Parcel’s width. Length unit is centimetre (cm) |
| length | integer(int32) | true | none | Parcel’s length. Length unit is centimetre (cm) |
| weight | number | true | none | Parcel’s weight. Mass unit is kilogram (kg). |
| quantity | integer(int32) | false | none | none |
| contentDescription | string | false | none | The content of the parcel. Mandatory in case of dangerous goods. |
CashOnDelivery
{
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | number | true | none | COD decimal value. Default currency is EUR. |
| currency | string | false | none | Not used. |
| paymentMethod | string | false | none | Not used. |
TrackingData
{
"carrier": "Aramex",
"awbNumber": "string",
"registrationTime": "string",
"expectedDeliveryTime": "string",
"serviceType": "EXPRESS",
"sender": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"consignee": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"auxiliaryAddress": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"awbNumber": "string"
}
],
"trackingEventList": [
{
"dateTime": "string",
"trackingStatus": "string",
"location": "string",
"description": "string",
"lmsTrackingStatus": "UNKNOWN"
}
]
}
Properties
None
ShipmentSettings
{
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| saturdayDelivery | boolean | false | none | Indicates if saturday delivery applies for the shipment |
| ddp | boolean | false | none | Indicates if DDP (Delivered Duty Paid) applied for the shipment |
| insurance | boolean | false | none | Indicates if insurance applied for the shipment |
| pickupOrder | boolean | false | none | Pickup is ordered if element’s value is true. Autopickup otherwise. If pickupOrder is false, pickupInterval time fields (timeFrom, timeTo) are not required. If pickupOrder is false, today as pickupdate (date) is possible till global cut off (17:30). If pickupOrder is true, service is bookable on the same day till cut off time. |
| pickupTailLift | boolean | false | none | Indicates if vehicle with tail lift is needed for pickup. This option is valid for pallet services only. |
| deliveryTailLift | boolean | false | none | Indicates if vehicle with tail lift is needed for delivery. This option is valid for pallet services only. |
| holidayDelivery | boolean | false | none | Indicates if Holiday delivery is requested. |
ShipmentDetails
{
"shipmentType": "PARCEL",
"transportType": "EXPRESS",
"shipmentSettings": {
"saturdayDelivery": false,
"ddp": false,
"insurance": false,
"pickupOrder": true,
"pickupTailLift": false,
"deliveryTailLift": false,
"holidayDelivery": false
},
"goodsValue": 1,
"exworks": {
"accountNumber": "string",
"exworkType": "THIRD_PARTY_PAYS",
"address": {
"address": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "NY",
"specialField": "string"
},
"company": "string",
"person": {
"title": "MRS",
"firstname": "string",
"lastname": "string"
},
"phone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
},
"email": "string"
}
},
"parcelList": [
{
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"quantity": 1,
"contentDescription": "string",
"tariffNumbers": [
"string"
],
"additionalHandling": false,
"dangerousGoods": {
"regulation": "ADR",
"accessibility": "ACCESSIBLE",
"properShippingName": "string",
"chemicalRecordIdentifier": "string",
"regulationLevel": "string",
"classification": "Class1",
"classificationDivision": "Class11",
"idNumber": "string",
"quantity": "string",
"unitOfMeasure": "GRAMM",
"packagingType": "string",
"packagingGroup": "string",
"packagingTypeQuantity": "string",
"specialServiceType": "string",
"transportationMode": "GND",
"numberOfContainers": "string",
"packagingInstructions": "string",
"subRiskClass": "string",
"adrItemNumber": "string",
"adrPackagingGroupLetter": "string",
"recordIdent1": "string",
"recordIdent2": "string",
"recordIdent3": "string",
"contact": [
{
"title": "string",
"name": "string",
"place": "string",
"emergencyPhoneNumber": "string"
}
]
},
"cashOnDelivery": {
"value": 0,
"currency": "string",
"paymentMethod": "string"
}
}
],
"pickupInterval": {
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
},
"contentDescription": "string",
"note": "string",
"driverInfo": "string",
"customReferenceCodes": [
{
"label": "string",
"value": "string"
}
],
"defaultReferenceCode": "string"
}
Properties
None
PickupInterval
{
"date": "2012-01-25",
"timeFrom": "09:30:00",
"timeTo": "09:30:00"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string | true | none | Pickup date. Possible to set today date if booked before cut off time (global cut off time 17:30 when autopickup ordered / service specific cut off time when pickup ordered; see pickupOrder definition). The date is specified in the following format "yyyy-MM-dd". |
| timeFrom | string | false | none | Time from which it will be possible to pick shipment. Default value is 9:00:00. Not required when pickupOrder set to false (autopickup). The time is specified in the following format "hh:mm:ss". |
| timeTo | string | false | none | Time to which it will be possible to pick shipment. Default value is 18:00:00. Not required when pickupOrder set to false (autopickup). The time is specified in the following form "hh:mm:ss". |
CustomReferenceCode
{
"label": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| label | string | true | none | none |
| value | string | true | none | none |
BaseServiceDetails
{
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | true | none | Internal LetMeShip identifier of the service. See https://www.letmeship.de/ServicesOverview |
| name | string | true | none | Name of the service |
ServiceDetails
{
"baseServiceDetails": {
"id": 0,
"name": "string",
"carrier": "Aramex",
"carrierImage": "string",
"priceInfo": {
"realWeight": 0,
"dimensionalWeight": 0,
"billingWeight": 0,
"basePrice": 0,
"discountedPrice": 0,
"netPrice": 0,
"totalVat": 0,
"totalPrice": 0,
"surcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
],
"specialSurcharges": [
{
"name": "Fuel surcharge",
"amount": 0,
"percentage": 0
}
]
}
},
"cutOffTime": "09:30:00",
"transferTime": "string",
"supportedExWorkType": [
"THIRD_PARTY_PAYS"
],
"messages": [
"string"
],
"description": "string",
"serviceInfo": "string"
}
Properties
None
ShipmentNotification
{
"addtionalCarrierNotification": {
"email": "string",
"mobilePhone": {
"phoneNumber": "string",
"phoneNumberPrefix": "string"
}
},
"trackingNotification": {
"deliveryNotification": true,
"problemNotification": true,
"emails": [
"string"
],
"notificationText": "string"
},
"recipientNotification": {
"notificationText": "string",
"emails": [
"string"
]
}
}
Shipment notifications data.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addtionalCarrierNotification | object | false | none | Additional carrier notification data (e.g. DPD predict). |
| string | false | none | Email address. | |
| trackingNotification | object | true | none | Tracking notification data. |
| » deliveryNotification | boolean | false | none | Defines if tracking delivery notification email should be sent to email addresses. |
| » problemNotification | boolean | false | none | Defines if tracking problem notification email should be sent to email addresses. |
| » emails | [string] | false | none | Tracking notification email addresses. |
| » notificationText | string | false | none | none |
| recipientNotification | object | false | none | Recipient notification data. |
| » notificationText | string | false | none | Tracking notification text. |
| » emails | [string] | false | none | none |
CreateShipmentOrdersRequest
{
"shipmentOrders": [
{
"identifier": "string",
"pickupAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"deliveryAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"orderDetails": {
"shipmentType": "PARCEL",
"goodsValue": 0,
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"contentDescription": "string",
"additionalHandling": false,
"customReferenceCodes": [],
"items": {
"label": "string",
"value": "string"
},
"defaultReferenceCode": "string"
}
}
]
}
Used to create shipment templates. That in turn are used in user's UI for quicker shipment creation.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| shipmentOrders | [ShipmentOrder] | true | none | List of shipment orders |
ShipmentOrder
{
"identifier": "string",
"pickupAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"deliveryAddress": {
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
},
"orderDetails": {
"shipmentType": "PARCEL",
"goodsValue": 0,
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"contentDescription": "string",
"additionalHandling": false,
"customReferenceCodes": [],
"items": {
"label": "string",
"value": "string"
},
"defaultReferenceCode": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identifier | string | false | none | Shipment order identifier. |
OrderAddress
{
"countryCode": "AD",
"zip": "20251",
"city": "string",
"street": "string",
"houseNo": "string",
"addressInfo1": "string",
"addressInfo2": "string",
"stateCode": "string",
"specialField": "string",
"company": "string",
"title": "MRS",
"firstname": "string",
"lastname": "string",
"phoneNumber": "string",
"phoneNumberPrefix": "string",
"email": "string"
}
Properties
None
OrderDetails
{
"shipmentType": "PARCEL",
"goodsValue": 0,
"height": 0,
"width": 0,
"length": 0,
"weight": 0,
"contentDescription": "string",
"additionalHandling": false,
"customReferenceCodes": [],
"items": {
"label": "string",
"value": "string"
},
"defaultReferenceCode": "string"
}
Shipment details data. Only one parcel is allowed for shipment order
Properties
None
CreateShipmentOrdersResponse
{
"identifiers": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identifiers | [string] | true | none | The identifiers of created Shipment Order in LetMeShip. |