This API allows listing all consignments of an account with summary data.
| Property | Value |
|---|---|
| URL | {{BASE_URL}}/api/v1/consignments |
| HTTP Method | GET |
| Content Type | application/json |
| Authentication | APIKEY header |
| Parameter Name | Parameter Type | Required | Description |
|---|---|---|---|
page |
Integer | Optional | Page number |
limit |
Integer | Optional | Listing limit per page |
Below is an example HTTP raw request for the API request.
GET {{BASE_URL}}/api/v1/consignments?page=1&limit=10
Content-Type: application/json
APIKEY: {{APIKEY}}On a successful request, the API will return a response like this:
{
"status": true,
"message": null,
"data": [
{
"id": 632280,
"uuid": "3c1563eb-9afd-4eda-8c26-51174d805b08",
"barcode": "C2H07238640094",
"reference_no": "XYZ123",
"consignmentType": 0,
"status": 1,
"status_message": "Consignment sent to provider",
"consignee": {
"name": "John Doe",
"attention_name": "John Doe",
"country": "Turkey",
"countryIso3": "TUR",
"state": "Bursa",
"city": "Nilüfer",
"address": "Sample Address Street No:1",
"postal_code": "16285",
"phone": "905551234567",
"email": "consignee@example.com"
},
"consignor": {
"name": "Sender Company Inc.",
"attention_name": "Sender Company Inc.",
"country": "Turkey",
"countryIso3": "TUR",
"state": "İstanbul",
"city": "Arnavutköy",
"address": "Sample District, Sample Street No:1",
"postal_code": "34277",
"phone": "905559876543",
"email": "consignor@example.com"
},
"created_at": "2025-02-18 13:21:16",
"updated_at": "2025-02-18 13:21:18",
"total_cost": 120.96,
"currency_code": "TRY",
"currency_rate": 1,
"customer": {
"id": 1,
"customer_code": "1",
"name": "Customer Name",
"authorized_name": null
},
"user": {
"id": 1,
"firstname": "John",
"lastname": "Doe"
},
"provider": {
"id": 1,
"name": "Ptt",
"logo": "http://localhost/uploads/provider_logos/ptt.png"
}
}
],
"meta": {
"page": 1,
"limit": 10,
"total": 9
}
}