Register or Login
In the request header params, you must pass the parameters (header name and header password) that you specified during registration:
- username
- password

For example,

Header name Header value

username username@gmail.com

password 123456

View as document
Name Type Description
TrackingRequestModel
TrackingItems TrackingItems []
TrackingItem
ShipmentDescription String
TrackingNumber String

Request Format

application/json, text/json
Sample: 

{
  "TrackingRequest": {
    "TrackingItems": [
      {
        "TrackingNumber": "RP000017624RU"
      }
    ]
  }
}

Response Formats

application/json, text/json
Sample: 
{
  "TrackingRequest": {
    "responseStatus": {
      "Code": "200",
      "Description": "Success"
    },
    "trackingResponse": [
      {
        "History": [
          {
            "TrackingNumber": "RP000017624RU",
            "OperationDate": "09/09/2018",
            "DeliveryStatus": "SortingCenter",
            "PostCode": "143143",
            "Address": "Taganrog"
          }
        ]
      }
    ]
  }
}
View as document
Name Type Description
Purchases
Purchases Purchases[]
General
LabelType String 1 - return the link to file; 2 - return file in base64 format; 3 - return the link to file and file in base64 format; 4 - do not return anything
ShopPurchaseDate String Shop purchase date in US date format (yyyy-MM-dd)
ProductNumber String
CreateDispatch String Sign of the inclusion of an order online store in a single shipment. 1 - create Shipment.
Comment String Comment to the order, a maximum of 500 characters.
OrderNo String Order number in the online store.
ConsigneeInfo ReceiverInformation Information about Consignee
SenderInfo SenderInformation Information about Sender
Commercial Commercial
Cargo Cargo
ReceiverInformation
FullName String
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String Taxpayer Identification Number (TIN). Indicated only for citizens of the Russian Federation. TIN consists of 12 digits.
SenderInformation
FullName String Company full name
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String
Commercial
Invoice String Invoice number (account).
InvoiceFile String Link to invoice file.
ServiceType String Service name (parcel type): Parcel - regular parcel up to 20 kg, Small Package - small parcel up to 2 kg, EMS - expedited parcel up to 31.5 kg.You must specify one of the values:parcel,small_package,ems
Services String Services to order: 1 - customs clearance services (customs clearance), 2 - insurance of departure, 3 - destroy in case of non delivery. All services - 1, 2, 3.
IsDestroyUndelivered Boolean Destroy in case of undeliverable parcel: true - destroy, false - do not destroy.
ShipmentCategory String Category of departure. You must specify one of the values: commercial, sample, documents, gift.
Products Products []
TermsOfDelivery String
Products
ProductNumber String Number of product
Description String
ProductType String Type of product: product or service. You must specify one of the values: goods, service.
CustomsCode String HS code, 6, 8 or 10 digits.
Qty String Quantity
PositionWeight String The total weight of the product in grams.
PositionAmountEUR String The total cost of goods in cents.
Currency String
CountryOfOrigin String
Cargo
Packages Packages []
Packages
PackingCode String Package packing code. You must specify one of the values: bag, box, carton, crate, drum, envelope, europallet, pallet.
Length String Cargo Length in cm
Width String Cargo Width in cm
Height String Cargo Height in cm
Weight String Cargo weight in grams. The sum of cargo weights must be equal to or greater than the total weight of goods in the shipment.

Request Format

application/json, text/json
Sample: 
{  
  "Purchases": [
    {
      "General": {
        "ShopPurchaseDate": "2019-01-01",
        "ShopPurchaseNumber": "shop_num_123",
        "CreateDispatch": "0",
        "Comment": "comment about purchase",
		"LabelType":"1",
        "OrderNo": "1QW3_text",
        "ConsigneeInfo": {
          "FullName": "Kapshukova Viktoriya",
          "Country": "Russian Federation",
          "Region": "Shelkovo",
          "City": "Shelkovo",
          "PostCode": "141000",
          "Address": "Institutskaya 2a 84 c/o Viktoriya Kapshukova",
          "Phone": "'+7 9264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru",
          "TIN": ""
        },
        "SenderInfo": {
          "FullName": "Shop Oy",
          "Country": "Finland",
          "Region": "",
          "City": "Virolahti",
          "PostCode": "00101",
          "Address": "Vaahterikontie",
          "Phone": "'+7 9264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru"
        },
        "Commercial": {
          "Invoice": "",
          "InvoiceFile": "",
          "ServiceType": "parcel",
          "Services": "1",
          "ShipmentCategory": "gift",
          "Products": [
            {
              "SequenceNumber": "1",
              "ProductNumber": "346",
              "Description": "jeans",
              "ProductType": "goods",
              "CustomsCode": "",
              "Qty": "2",
              "PositionWeight": "1020",
              "PositionAmountEUR": "1500"
            }
          ]
        },
        "Cargo": {
          "Packages": [
            {
              "PackingCode": "box",
              "Length": "20",
              "Width": "30",
              "Height": "20",
              "Weight": "1500"
            }
          ]
        }
      }
    }
  ]
}

Response Formats

application/json, text/json
Sample: 

"{"CreatePurchases":
	{"createPurchasesResponse":
		{"responseStatus":
			{
				"Code":"200","Description":"Success"
			},
			"response":[
				{"PLSPurchaseNumber":"PR1906250000400","RPTrackingNumber":"CA000004342RU"}
			],
			"label":[
				{"Path":"http://els.web-automation.ru/uploads/enterprise/links/PR19062500004016.pdf","Body":null}
			]
		}
	}
}"
View as document
Name Type Description
Purchases
Purchases Purchases[]
General
LabelType String 1 - return the link to file; 2 - return file in base64 format; 3 - return the link to file and file in base64 format; 4 - do not return anything
ShopPurchaseDate String Shop purchase date in US date format (yyyy-MM-dd)
ProductNumber String
Comment String Comment to the order, a maximum of 500 characters.
OrderNo String Order number in the online store.
ConsigneeInfo ReceiverInformation Information about Consignee
SenderInfo SenderInformation Information about Sender
Commercial Commercial
Cargo Cargo
ReceiverInformation
FullName String
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String Taxpayer Identification Number (TIN). Indicated only for citizens of the Russian Federation. TIN consists of 12 digits.
SenderInformation
FullName String Company full name
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String
Commercial
Invoice String Invoice number (account).
InvoiceFile String Link to invoice file.
ServiceType String Service name (parcel type): Parcel - regular parcel up to 20 kg, Small Package - small parcel up to 2 kg, EMS - expedited parcel up to 31.5 kg.You must specify one of the values:parcel,small_package,ems
Services String Services to order: 1 - customs clearance services (customs clearance), 2 - insurance of departure, 3 - destroy in case of non delivery. All services - 1, 2, 3.
IsDestroyUndelivered Boolean Destroy in case of undeliverable parcel: true - destroy, false - do not destroy.
ShipmentCategory String Category of departure. You must specify one of the values: commercial, sample, documents, gift.
Products Products []
TermsOfDelivery String
Products
ProductNumber String Number of product
Description String
ProductType String Type of product: product or service. You must specify one of the values: goods, service.
CustomsCode String HS code, 6, 8 or 10 digits.
Qty String Quantity
PositionWeight String The total weight of the product in grams.
PositionAmountEUR String The total cost of goods in cents.
Currency String
CountryOfOrigin String
Cargo
Packages Packages []
Packages
PackingCode String Package packing code. You must specify one of the values: bag, box, carton, crate, drum, envelope, europallet, pallet.
Length String Cargo Length in cm
Width String Cargo Width in cm
Height String Cargo Height in cm
Weight String Cargo weight in grams. The sum of cargo weights must be equal to or greater than the total weight of goods in the shipment.

Request Format

application/json, text/json
Sample: 
{  
  "Purchases": [
    {
      "General": {
        "ShopPurchaseDate": "2019-01-01",
        "ShopPurchaseNumber": "shop_num_123",
        "Comment": "comment about purchase",
		"LabelType":"1",
        "OrderNo": "1QW3_text",
        "ConsigneeInfo": {
          "FullName": "Kapshukova Viktoriya",
          "Country": "Russian Federation",
          "Region": "Shelkovo",
          "City": "Shelkovo",
          "PostCode": "141000",
          "Address": "Institutskaya 2a 84 c/o Viktoriya Kapshukova",
          "Phone": "'+7 9264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru",
          "TIN": ""
        },
        "SenderInfo": {
          "FullName": "Shop Oy",
          "Country": "Finland",
          "Region": "",
          "City": "Virolahti",
          "PostCode": "00101",
          "Address": "Vaahterikontie",
          "Phone": "'+7 9264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru"
        },
        "Commercial": {
          "Invoice": "",
          "InvoiceFile": "",
          "ServiceType": "parcel",
          "Services": "1",
          "ShipmentCategory": "gift",
          "Products": [
            {
              "SequenceNumber": "1",
              "ProductNumber": "346",
              "Description": "jeans",
              "ProductType": "goods",
              "CustomsCode": "",
              "Qty": "2",
              "PositionWeight": "1020",
              "PositionAmountEUR": "1500"
            }
          ]
        },
        "Cargo": {
          "Packages": [
            {
              "PackingCode": "box",
              "Length": "20",
              "Width": "30",
              "Height": "20",
              "Weight": "1500"
            }
          ]
        }
      }
    }
  ]
}

Response Formats

application/json, text/json
Sample: 

"{"CreatePurchases":
	{"createPurchasesResponse":
		{"responseStatus":
			{
				"Code":"200","Description":"Success"
			},
			"response":[
				{"PLSPurchaseNumber":"PR1906250000400","RPTrackingNumber":"CA000004342RU"}
			],
			"label":[
				{"Path":"http://els.web-automation.ru/uploads/enterprise/links/PR19062500004016.pdf","Body":null}
			]
		}
	}
}"
View as document
Name Type Description
Purchases
general General
ID Int32
General
DistatchID String
DeliveryPrice String
LabelType String 1 - return the link to file; 2 - return file in base64 format; 3 - return the link to file and file in base64 format; 4 - do not return anything
PurchaseID String
EstimatedPrice String
TrackingNumber String
ShopPurchaseDate String Shop purchase date in US date format (yyyy-MM-dd)
ProductNumber String
CreateDispatch String Sign of the inclusion of an order online store in a single shipment. 1 - create Shipment.
Comment String Comment to the order, a maximum of 500 characters.
OrderNo String Order number in the online store.
ConsigneeInfo ReceiverInformation Information about Consignee
SenderInfo SenderInformation Information about Sender
Commercial Commercial
Cargo Cargo
ReceiverInformation
FullName String
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String Taxpayer Identification Number (TIN). Indicated only for citizens of the Russian Federation. TIN consists of 12 digits.
SenderInformation
FullName String Company full name
Country String
Region String
City String
PostCode String
Address String
Phone String
Email String
TIN String
Commercial
Invoice String Invoice number (account).
InvoiceFile String Link to invoice file.
ServiceType String Service name (parcel type): Parcel - regular parcel up to 20 kg, Small Package - small parcel up to 2 kg, EMS - expedited parcel up to 31.5 kg.You must specify one of the values:parcel,small_package,ems
Services String Services to order: 1 - customs clearance services (customs clearance), 2 - insurance of departure, 3 - destroy in case of non delivery. All services - 1, 2, 3.
IsDestroyUndelivered Boolean Destroy in case of undeliverable parcel: true - destroy, false - do not destroy.
ShipmentCategory String Category of departure. You must specify one of the values: commercial, sample, documents, gift.
Products Products []
TermsOfDelivery String
Products
ID String
ProductNumber String Number of product
Description String
ProductType String Type of product: product or service. You must specify one of the values: goods, service.
CustomsCode String HS code, 6, 8 or 10 digits.
Qty String Quantity
PositionWeight String The total weight of the product in grams.
PositionAmountEUR String The total cost of goods in cents.
Currency String
CountryOfOrigin String
Cargo
Packages Packages []
Packages
ID String
PackingCode String Package packing code. You must specify one of the values: bag, box, carton, crate, drum, envelope, europallet, pallet.
Length String Cargo Length in cm
Width String Cargo Width in cm
Height String Cargo Height in cm
Volume String Automatically calculated
Weight String Cargo weight in grams. The sum of cargo weights must be equal to or greater than the total weight of goods in the shipment.

Request Format

application/json, text/json
Sample: 
{
  "Purchase": {
    "General": {     
      "LabelType": "1",
      "TrackingNumber": "ТР2000",
      "ShopPurchaseDate": "2019-01-01",
      "ShopPurchaseNumber": "Glu579Aвс4lа1er",
      "Comment": "asdsadd",
      "OrderNo": "Juli999",
      "PurchaseID": "PR1903120000400",
      "ConsigneeInfo": {
        "FullName": "GLushko Alina",
        "Country": "Russian Federation",
        "Region": "Shelkovo",
        "City": "Shelkovo",
        "PostCode": "141000",
        "Address": "Institutskaya 2a 84 c/o Semenuk Juli",
        "Phone": "'+7 9264306916",
        "Email": "juli-ua.91@mail.ru",
        "TIN": ""
      },
      "SenderInfo": {
        "Country": "Finland",
        "Region": "reg",
        "City": "Virolahti",
        "PostCode": "00101",
        "Address": "Vaahterikontie",
        "Phone": "'+7 9264306916",
        "Email": "Viktoriya.Kapshukova@mail.ru"
      },
      "Commercial": {
        "Invoice": "",
        "InvoiceFile": "",
        "ServiceType": "Parcel",
        "ServiceELS": "1, 2",
        "ShipmentCategory": "commercial",
        "Products": [
          {
            "ID": "1670",
            "SequenceNumber": "1",
            "ProductNumber": "111111",
            "Description": "books",
            "ProductType": "goods",
            "CustomsCode": "",
            "Qty": "9",
            "PositionWeight": "1500",
            "PositionAmountEUR": "30000"
          },
          {
            "ID": "0",
            "SequenceNumber": "1",
            "ProductNumber": "31246",
            "Description": "jeans",
            "ProductType": "goods",
            "CustomsCode": "",
            "Qty": "10",
            "PositionWeight": "1000",
            "PositionAmountEUR": "12000"
          }
        ]
      },
      "Cargo": {
        "Packages": [
          {
            "ID": "1605",
            "PackingCode": "box",
            "Length": "30",
            "Width": "40",
            "Height": "30",
            "Weight": "5000"
          }
        ]
      }
    }
  }
}

Response Formats

application/json, text/json
Sample: 
"{"Response":
	{"ResponseStatus":
		{"Code":"200","Description":"Success"},
		"purchaseLabel":
		[
			{"Path":"http://els.web-automation.ru/uploads/enterprise/links/PR19062500004016.pdf","Body":null}
		]
	}
}"
View as document
Name Type Description
Purchase
PurchaseId String
LabelType String 1 - return the link to file; 2 - return file in base64 format; 3 - return the link to file and file in base64 format; 4 - do not return anything

Request Format

application/json, text/json
Sample: 
{
  "Purchase": {
    "PurchaseId": "PR1903150000200",
    "LabelType": "2"
  }
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "PurchaseInfo": {
      "general": {
        "DistatchID": "",
        "DeliveryPrice": "",
        "IsClearanceDocuments": "False",
        "IsInsurance": "False",
        "LabelType": null,
        "PurchaseID": "PR1903150000200",
        "EstimatedPrice": "8,00",
        "TrackingNumber": "CA000002854RU",
        "ShopPurchaseDate": "01.01.2019 0:00:00",
        "ProductNumber": null,
        "CreateDispatch": null,
        "Comment": "asdsadd",
        "OrderNo": "G98Cgx91",
        "ConsigneeInfo": {
          "FullName": null,
          "Country": "RUSSIAN FEDERATION",
          "Region": "Shelkovo",
          "City": "Shelkovo",
          "PostCode": "141000",
          "Address": "Institutskaya 2a 84 c/o Viktoriya Kapshukova",
          "Phone": "+79264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru",
          "TIN": ""
        },
        "SenderInfo": {
          "FullName": null,
          "Country": "",
          "Region": "reg",
          "City": "Virolahti",
          "PostCode": "00101",
          "Address": "Vaahterikontie",
          "Phone": "+79264306916",
          "Email": "Viktoriya.Kapshukova@mail.ru"
        },
        "Commercial": {
          "Invoice": "",
          "InvoiceFile": null,
          "ServiceType": null,
          "Services": "Parcel (max. 20 kg)",
          "ShipmentCategory": "Commercial",
          "Products": [
            {
              "ID": "1672",
              "ProductNumber": "31246",
              "Description": "jeans",
              "ProductType": "goods",
              "CustomsCode": null,
              "Qty": "10",
              "PositionWeight": "3,000",
              "PositionAmountEUR": "120,00"
            },
            {
              "ID": "1673",
              "ProductNumber": "31246",
              "Description": "jeans",
              "ProductType": "goods",
              "CustomsCode": null,
              "Qty": "10",
              "PositionWeight": "1,000",
              "PositionAmountEUR": "60,00"
            }
          ]
        },
        "Cargo": {
          "Packages": [
            {
              "ID": "1607",
              "PackingCode": "Box",
              "Length": "30,00",
              "Width": "40,00",
              "Height": "30,00",
              "Volume": "0,036",
              "Weight": "5,000"
            },
            {
              "ID": "1608",
              "PackingCode": "Box",
              "Length": "30,00",
              "Width": "40,00",
              "Height": "30,00",
              "Volume": "0,036",
              "Weight": "0,500"
            }
          ]
        }
      }
    },
    "ResponseStatus": {
      "Code": "200",
      "Description": "Success"
    },
    "label": [
      {
        "Path": null,
        "Body": ""
      },
      {
        "Path": null,
        "Body": ""
      }
    ]
  }
}
View as document
Name Type Description
PurchasesIds
PurchasesIds string[]

Request Format

application/json, text/json
Sample: 
{
  "PurchasesIds": [
    "PR1903110012800"
  ]
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "ResponseStatus": {
      "Code": "200",
      "Description": "Success"
    },
    "ResponsePurchases": [
      {
        "PurchaseID": "PR1903110012800",
        "Result": "Success"
      }
    ]
  }
}
View as document
Name Type Description
BaseDispatchDataModel
PurchasesIds PurchasesIds []
TrackingNumber String
DispatchShipper String
Created String
DispatchRouteInformation DispatchRouteInformation
ShipmentInformation DispatchShipmentInformation
Products Products []
DispatchNumber String
DispatchRouteInformation
From DispatchRouteInformationFrom
To DispatchRouteInformationTo
DispatchRouteInformationFrom
Address String
PostalCode String
City String
Country String
FullName String
Phone String
DispatchRouteInformationTo
Address String
PostalCode String
City String
Country String
FullName String
Phone String
DispatchShipmentInformation
Description String
DangerCargoType String
UnNumber String
HazardCategory String
DeclaredValue String
DispatchProduct
PackingCode String
CargoPlaces String
WeightKg String
LengthCm String
WidthCm String
HeightCm String
ID String
VolumeM String
TotalVolume Decimal

Request Format

application/json, text/json
Sample: 
{
  "Dispatch": {
    "PurchasesIds": [
      "PR1903210000100",
      "PR1903150000200"
    ],
    "TrackingNumber": "",
    "DispatchShipper": "",
    "DispatchRouteInformation": {
      "From": {
        "Address": "Pushkina",
        "PostalCode": "86009",
        "City": "Donetsk",
        "Country": "Russian federation"
      },
      "To": {
        "Address": "",
        "PostalCode": "",
        "City": "",
        "Country": "Finland"
      }
    },
    "ShipmentInformation": {
      "Description": "12",
      "DangerCargoType": "",
      "UnNumber": "",
      "HazardCategory": ""
    },
    "Products": [
      {
        "PackingCode": "",
        "CargoPlaces": "",
        "WeightKg": "",
        "LengthCm": "",
        "WidthCm": "",
        "HeightCm": "",
        "VolumeM": ""
      }
    ]
  }
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "ResponseStatus": {
      "Code": "200",
      "Description": "Success"
    },
    "DispatchId": ""
  }
}
View as document
Name Type Description
DispatchApiModel
DispatchID String
LabelType String 1 - return the link to file; 2 - return file in base64 format; 3 - return the link to file and file in base64 format; 4 - do not return anything

Request Format

application/json, text/json
Sample: 
{
  "Dispatch": {
    "DispatchID": "DS1903240000100",
    "LabelType":"3"
  }
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "ResponseStatus": {
      "Code": "200",
      "Description": "Success"
    },
    "Dispatch": {
      "Files": [
        {
          "Path": "http://els.web-automation.ru/uploads/enterprise/dispatches/271/test.pdf",
          "Body":"1234"
},
        {
          "Path": "http://els.web-automation.ru/uploads/enterprise/dispatches/271/test.pdf",
		  "Body":"45677"
           }
      ],
      "PurchasesIds": [
        "PR1903150000200",
        "PR1903210000100"
      ],
      "TrackingNumber": "test123",
      "DispatchShipper": "",
      "Created": "24.03.2019 10:57:13",
      "DispatchRouteInformation": {
        "From": {
          "Address": "Pushkina",
          "PostalCode": "86009",
          "City": "Donetsk",
          "Country": "RUSSIAN FEDERATION"
        },
        "To": {
          "Address": null,
          "PostalCode": null,
          "City": null,
          "Country": "FINLAND"
        }
      },
      "ShipmentInformation": {
        "Description": "12",
        "DangerCargoType": "No",
        "UnNumber": null,
        "HazardCategory": "No",
        "DeclaredValue": "0"
      },
      "Products": [
      {
        "PackingCode": "box",
        "CargoPlaces": "1",
        "WeightKg": "12",
        "LengthCm": "12",
        "WidthCm": "12",
        "HeightCm": "12",
        "VolumeM": "12"
      }
    ]
    }
  }
}
View as document
Name Type Description
DispatchID
DispatchID string
Documents
Documents DocumentModel[]
DocumentModel
FileName String
FileBase64 String

Request Format

application/json, text/json
Sample: 

{
  "DispatchID": "DS1903240000100",
  "Documents": [
    {
      "FileName": "test.pdf",
      "FileBase64": "1223sd"
    }
  ]
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "Code": "200",
    "Description": "Success"
  }
}
View as document
Name Type Description
DispatchID
DispatchID string
TrackingNumber
TrackingNumber string

Request Format

application/json, text/json
Sample: 

{
  "DispatchID": "DS1903180000100",
  "TrackingNumber": "14444442"
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "Code": "200",
    "Description": "Success"
  }
}
View as document
Name Type Description
DeletePurchases
DispatchID String
PurchasesIds PurchasesIds []

Request Format

application/json, text/json
Sample: 
{
  "purchases": {
    "DispatchID": "DS1902060000100",
    "PurchasesIds": [
      "PR1902060000100"
    ]
  }
}

Response Formats

application/json, text/json
Sample: 
{
  "Response": {
    "Code": "200",
    "Description": "Success"
  },
  "DispatchResponse": [
    {
      "PurchaseID": "PR1902060000100",
      "ResultMessage": "Success"
    }
  ]
}
About us

Since 2003 WCARGO provide to customers best solutions for transport and warehousing services. We introduce to You our product "myELS" - finally developed for sending parcels and packets from-to all over the world.

Quick links
Subscribe

Get the latest updates and offers.