GET v1/cargoes/{companyCode}/{cargoId}?apiToken={apiToken}

Returns information about a specific active cargo

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

The company code you are retreiving information for

 string

Required
cargoId

The ID of the cargo

 integer

Required
apiToken

Your API Token

 string

None.

Body Parameters

None.

Response Information

Resource Description

CargoResponse
NameDescriptionTypeAdditional information
ID

integer

None.
ShortName

string

None.
FullName

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "shortName": "sample string 2",
  "fullName": "sample string 3"
}

application/xml, text/xml

Sample: 
<Cargo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <ShortName>sample string 2</ShortName>
  <FullName>sample string 3</FullName>
</Cargo>