Get Shipment Details API
GET
/api/v3/shipments
Overview
The Shipment Details API retrieves detailed information about an existing shipment in Fredi. This endpoint allows client systems to fetch shipment metadata, carrier information, parcel details, and tracking information using the shipment reference number.
This API is typically used for:
- Retrieving shipment status
- Viewing parcel and carrier information
- Tracking shipment processing
- Verifying shipment creation
Important
The shipment must already exist in the system!
The API identifies the shipment using the shipmentReference field!
Endpoint
GET
/api/v3/shipments
This endpoint allows you to:
- Retrieve shipment details using the shipment reference number
- Check shipment status
- View parcel and carrier information
Authentication
All requests must include a valid Bearer token.
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer {access_token} |
| Content-Type | Yes | application/json |
See: Authentication section for token generation.
Request Body
The Get Shipment Details API expects a JSON payload containing the shipment reference for which the details need to be retrieved.
{
"shipmentDetails": [
{
"shipmentReferenceNumber": "SHIP122358"
}
]
}
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
| shipmentReferenceNumber | string | Yes | Path | Unique reference number of the shipment |
| shipmentStatus | integer | No | Query | Optional shipment status filter |
Structure
Note
The schema tree below is automatically generated from the OpenAPI specification!
Loading schema…
Note
The example below is automatically generated from the OpenAPI specification!
Sample Request
Show Sample Request
{
"shipmentDetails": {
"shipmentReference": "PACK-00120"
}
}
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Invalid request payload |
| 401 | Unauthorized |
| 404 | Error - No shipment details found for the provided reference number. |
| 422 | Validation error |
| 500 | Internal server error |
Example Response
200 - OK
{
"shipment": [
{
"settings": {
"loadingLocation": "",
"packingStation": "",
"documentLanguage": "en",
"printDocuments": true,
"printSettings": {
"labelType": "PDF",
"labelSize": "A6",
"printLabel": true,
"splitByParcel": true,
"isUpdated": false,
"labelResponseOption": ""
}
},
"carrierDetails": {
"carrierCode": "DPD_DE",
"carrierContractNumber": "",
"contractDetailId": 6,
"productCode": "CL",
"orderType": "consignment",
"carrierService": [],
"shippingType": ""
},
"shipmentInfo": {
"shipmentId": 50123,
"shipmentReference": "PACK-00120",
"deliveryNoteNumber": "",
"invoiceNumber": "",
"orderNumber": "",
"description": "",
"customerOrderNumber": "",
"currency": "EUR",
"currentExchangeRate": 0,
"grossAmount": 0,
"grossAmountCurrency": "",
"incotermCode": "01",
"insuranceAmount": 0,
"insuranceCurrency": "",
"frankingCode": "",
"incotermPlace": "",
"incotermCountry": "",
"typeOfBusiness": 0,
"modeOfTransport": "",
"addressData": [
{
"sender": {
"addressType": "",
"customerNumber": "",
"name": "George david",
"name2": "test9",
"name3": "test6",
"street": "Ensisheimerstr",
"street2": "",
"postalCode": "01067",
"city": "Endingen am Kaiserstuhl",
"countryIsoCode": "DE",
"vatNumber": "",
"provinceCode": "",
"houseNo": "12b",
"zipCode": "",
"contactPerson": {
"name": "Thejus k",
"phone": "",
"mobile": "",
"email": ""
},
"eori": ""
},
"recipient": {
"addressType": "",
"customerNumber": "",
"name": "TechNova Solutions LLC",
"name2": "Suite 210",
"name3": "Building A",
"street": "Market Street",
"street2": "",
"postalCode": "94103",
"city": "San Francisco",
"countryIsoCode": "US",
"vatNumber": "",
"lockerId": "",
"postOfficeRetailId": "",
"postNumber": "",
"poBoxId": "",
"provinceCode": "CA",
"houseNo": "1450",
"zipCode": "",
"contactPerson": {
"name": "Thejus k",
"phone": "",
"mobile": "",
"email": ""
},
"eori": ""
},
"invoice": {
"addressType": "",
"customerNumber": "",
"name": "George david",
"name2": "test9",
"name3": "",
"street": "Ensisheimerstr",
"street2": "",
"postalCode": "01067",
"city": "Endingen am Kaiserstuhl",
"countryIsoCode": "DE",
"vatNumber": "",
"provinceCode": "",
"houseNo": "12b",
"zipCode": "",
"contactPerson": {
"name": "Thejus k",
"phone": "4155552378",
"mobile": "",
"email": "GFHGFJ@GHYJ.COM"
},
"eori": ""
}
}
],
"shipmentItems": [
{
"packageCode": "",
"labelNumber": "",
"dimensions": {
"length": 7.97,
"width": 7.97,
"height": 7.75,
"weight": 0,
"unitOfMeasurement": ""
},
"netWeight": 8,
"grossWeight": 8,
"quantity": 0,
"articles": [
{
"articleNumber": "Test67",
"description": "TEST896",
"quantity": 0,
"quantityUom": "",
"grossPrice": 0,
"priceCurrency": "",
"netWeight": 8,
"singlePrice": 0,
"unitPrice": 0,
"grossWeight": 8,
"tariffNumber": "142243244",
"limitedQuantity": false,
"countryOfOrigin": "DE",
"position": 0,
"additionalInformation": {
"customsInvoicePosition": 1
},
"stateOfOrigin": "",
"grossWeightUom": "",
"price": 0,
"numberOfPieces": 0,
"statisticalValue": 0
}
],
"packageCodeDangerousGoods": "DP",
"packageReference1": "",
"packageReference2": "",
"grossWeightUom": "",
"content": "",
"insuranceAmount": 0,
"insuranceCurrency": "",
"declaredValueAmount": 0,
"declaredValueCurrency": "",
"carrierService": [
{
"serviceCode": "",
"serviceInformation": [
{
"key": ""
}
]
}
],
"packetNumber": "",
"trackingNumber": "09985053408830"
},
{
"packageCode": "",
"labelNumber": "",
"dimensions": {
"length": 7.97,
"width": 7.97,
"height": 7.75,
"weight": 0,
"unitOfMeasurement": ""
},
"netWeight": 8,
"grossWeight": 8,
"quantity": 0,
"articles": [
{
"articleNumber": "Test67",
"description": "TEST896",
"quantity": 0,
"quantityUom": "",
"grossPrice": 0,
"priceCurrency": "",
"netWeight": 8,
"singlePrice": 0,
"unitPrice": 0,
"grossWeight": 8,
"tariffNumber": "142243244",
"limitedQuantity": false,
"countryOfOrigin": "DE",
"position": 0,
"additionalInformation": {
"customsInvoicePosition": 2
},
"stateOfOrigin": "",
"grossWeightUom": "",
"price": 0,
"numberOfPieces": 0,
"statisticalValue": 0
}
],
"packageCodeDangerousGoods": "DP",
"packageReference1": "",
"packageReference2": "",
"grossWeightUom": "",
"content": "",
"insuranceAmount": 0,
"insuranceCurrency": "",
"declaredValueAmount": 0,
"declaredValueCurrency": "",
"carrierService": [
{
"serviceCode": "",
"serviceInformation": [
{
"key": ""
}
]
}
],
"packetNumber": "",
"trackingNumber": "09985053408831"
}
],
"additionalFields": [],
"pickup": {
"tour": 0,
"quantity": 0,
"date": "",
"fromTime1": "",
"toTime1": "",
"fromTime2": "",
"toTime2": "",
"extraPickup": 0,
"location": "",
"pickupInstructions": "",
"pickupType": ""
},
"delivery": {
"day": "",
"dateFrom": "",
"dateTo": "",
"timeFrom": "",
"timeTo": ""
},
"additionalInformation": {},
"international": {
"invoiceDate": "",
"customsPaper": "",
"mrnNumber": "",
"customsEnclosure": false,
"collectiveCustomsClearance": false,
"containsDocuments": false,
"typeOfExportDeclaration": "",
"dateOfPresentationStart": "",
"dateOfPresentationEnd": "",
"intendedCustomsOfficeOfExit": "",
"meansOfTransportation": {
"modeOfTransportDomestic": 0,
"modeOfTransportBorder": 0,
"crossBorderTransportationType": 0,
"crossBorderTransportationLicensePlate": "",
"crossBorderTransportatioNationality": "",
"departureTransportationType": 0,
"departureTransportationLicensePlate": "",
"departureTransportationNationality": ""
},
"declaredValueCurrency": ""
},
"paymentInfo": {
"splitDutyVat": false,
"shippingChargesPayment": {
"type": 0,
"payer": "",
"accountNumber": "",
"name": "",
"countryIsoCode": "",
"postalCode": "",
"certifiedElectronicMail": "",
"interchangeSystemCode": ""
},
"dutiesPayment": {
"type": 1,
"payer": "",
"accountNumber": "",
"name": "",
"countryIsoCode": "",
"postalCode": "",
"certifiedElectronicMail": "",
"interchangeSystemCode": ""
}
},
"transportInformation": {
"domesticTransportType": "",
"crossBorderTransportType": ""
},
"pltDocumentData": []
}
}
],
"shipmentErrors": []
}
404 - Error
{
"shipmentErrors": [
{
"error": "No shipment details found for the provided reference number.",
"code": "404"
}
]
}
Important Notes
- Only shipments that are not yet processed by the carrier can be deleted.
- Carrier-integrated shipments may require carrier cancellation first.
- Deleting a shipment permanently removes it from the system.