GET api/v1/shipments/{shipmentId}/charge-lines
Retrieve Shipment Charge Lines.
“Charge line” or “billing line” specifying the service or item being charged to the customers, having relevant details like quantity, rate, and total amount. For example: “Charge line: Freight charges for 10 units at $50 per unit, totaling $500.”
Method: GET
URL: https://api.locate2u.com/api/v1/shipments/{shipmentId}/charge-lines
Input Parameters:
shipmentId
Required integer. This id here is the unique shipment id of the shipment in your Locate2u account.
Request Body This request does not require a request body.
Sample code
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.locate2u.com/api/v1/shipments/175368/charge-lines");
request.Headers.Add("Authorization", "Bearer yourBearerTokenHere");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.locate2u.com/api/v1/shipments/175368/charge-lines")
.method("GET", body)
.addHeader("Authorization", "Bearer yourBearerTokenHere")
.build();
Response response = client.newCall(request).execute();
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'GET',
'hostname': 'api.locate2u.com',
'path': '/api/v1/shipments/175368/charge-lines',
'headers': {
'Authorization': 'Bearer yourBearerTokenHere'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
'https://api.locate2u.com/api/v1/shipments/175368/charge-lines',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer yourBearerTokenHere'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import requests
url = "https://api.locate2u.com/api/v1/shipments/175368/charge-lines"
payload = {}
headers = {
'Authorization': 'Bearer yourBearerTokenHere'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
Response
The response for this request is a JSON object representing the charge lines for the specified shipment. Below is a JSON schema:
JSON
{
"type": "object",
"properties": {
"chargeLineId": {
"type": "string"
},
"description": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
}
}