GET shipment/getShipment/V2?id={id}&type={type}
Action will provide the details of a shipment using provided details.
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
Sandbox Url: http://sandbox-api.freightpop.com/shipment/getShipment/V2?id={id}&type={type}
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
EndPoint
Production Url: https://enterprise.freightpop.com/shipment/getShipment/V2?id={id}&type={type}Sandbox Url: http://sandbox-api.freightpop.com/shipment/getShipment/V2?id={id}&type={type}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
Required
|
|
type | GetShipmentBy |
Default value is QuoteId
|
Body Parameters
None.
Response Information
Resource Description
Shipment details
ShipmentDetailsResponseV2Name | Description | Type | Additional information |
---|---|---|---|
Data |
Shipment response object info |
Collection of ShipmentDetailsObjectV2 |
None. |
Code |
Response code returned by api |
HttpStatusCode |
None. |
Message |
Human readable message |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "ShipmentId": "sample string 1", "QuoteId": "sample string 2", "IsCancelled": true, "Carrier": { "Id": 1, "Name": "sample string 2", "AccountNickName": "sample string 3", "Service": { "Id": 1, "Name": "sample string 2" }, "ScacCode": "sample string 4" }, "Rate": { "Id": "sample string 1", "Currency": "sample string 2", "DiscountedCost": 3.0, "ListCost": 4.0, "Service": "sample string 5", "TransitDays": "sample string 6", "MarkedUpCost": 7.0, "FreightCharge": 8.0, "AccessorialsCharge": 9.0, "FuelSurCharge": 10.0, "AccessorialBreakDown": [ { "Key": "sample string 1", "Value": 2.1 }, { "Key": "sample string 1", "Value": 2.1 } ] }, "PaymentTerm": 1, "ThirdPartyAccountInfo": { "AccountNumber": "sample string 1", "Address": "sample string 2", "City": "sample string 3", "Country": "sample string 4", "Email": "sample string 5", "Name": "sample string 6", "Phone": "sample string 7", "State": "sample string 8", "Zip": "sample string 9" }, "ShipDate": "2024-09-07T19:29:24.7567046-07:00", "ShipperAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ReturnAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ConsigneeAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ITN": "sample string 4", "Reference1": "sample string 5", "Reference2": "sample string 6", "Reference3": "sample string 7", "Reference4": "sample string 8", "Reference5": "sample string 9", "Reference6": "sample string 10", "Items": [ { "InnerPieces": { "PackageType": 1, "Quantity": 1, "ItemNumber": "sample string 2", "Length": 3.1, "Width": 4.1, "Height": 5.1, "Weight": 6.1, "Description": "sample string 7", "FreightClass": "sample string 8", "NMFC": "sample string 9", "Hazmat": true, "UnNumber": "sample string 11", "TechnicalName": "sample string 12", "Unit": 1 }, "Description": "sample string 1", "FreightClass": 2.1, "Height": 3.1, "Length": 4.1, "PackageType": 1, "Quantity": 5, "Weight": 6.1, "Unit": 1, "Width": 7.1, "PackageId": "sample string 8", "CustomerPackageId": "sample string 9" }, { "InnerPieces": { "PackageType": 1, "Quantity": 1, "ItemNumber": "sample string 2", "Length": 3.1, "Width": 4.1, "Height": 5.1, "Weight": 6.1, "Description": "sample string 7", "FreightClass": "sample string 8", "NMFC": "sample string 9", "Hazmat": true, "UnNumber": "sample string 11", "TechnicalName": "sample string 12", "Unit": 1 }, "Description": "sample string 1", "FreightClass": 2.1, "Height": 3.1, "Length": 4.1, "PackageType": 1, "Quantity": 5, "Weight": 6.1, "Unit": 1, "Width": 7.1, "PackageId": "sample string 8", "CustomerPackageId": "sample string 9" } ], "ProductDetails": [ { "Country": "sample string 1", "HTSCode": "sample string 2", "Description": "sample string 3", "Number": "sample string 4", "PackageId": "sample string 5", "PricePerPiece": 6.0, "PricePerPiece2": 7.0, "PricePerPiece3": 8.0, "PricePerPiece4": 9.0, "Quantity": 10, "Quantity2": 11, "Quantity3": 12, "Quantity4": 13, "Unit": "sample string 14", "OrderNumber": "sample string 15", "LineType": "sample string 16", "LineNumber": "sample string 17", "UPC": "sample string 18", "Category": "sample string 19", "SKU": "sample string 20", "TechnicalName": "sample string 21" }, { "Country": "sample string 1", "HTSCode": "sample string 2", "Description": "sample string 3", "Number": "sample string 4", "PackageId": "sample string 5", "PricePerPiece": 6.0, "PricePerPiece2": 7.0, "PricePerPiece3": 8.0, "PricePerPiece4": 9.0, "Quantity": 10, "Quantity2": 11, "Quantity3": 12, "Quantity4": 13, "Unit": "sample string 14", "OrderNumber": "sample string 15", "LineType": "sample string 16", "LineNumber": "sample string 17", "UPC": "sample string 18", "Category": "sample string 19", "SKU": "sample string 20", "TechnicalName": "sample string 21" } ], "AdditionalDetails": { "Accessorials": [ 1, 1 ], "CarrierInsuranceAmount": 1.0, "CODDetails": { "Amount": 1.0, "ChargeCode": "sample string 2", "PaymentType": 1, "RemitAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" } }, "DeliveryConfirmation": 1, "HazmatEmergencyNo": "sample string 2", "HazmatContact": "sample string 3", "IsSaturdayDelivery": true, "IsDeliveryDutyPaid": true, "SpecialInstructions": "sample string 6", "PickupSpecialInstructions": "sample string 7", "Alcohol": true }, "PickupNumber": "sample string 11", "PickupDetails": { "ReadyDateTime": "sample string 1", "Emails": [ "sample string 1", "sample string 2" ], "CutoffDateTime": "sample string 2", "ScheduledShipDate": "2024-09-07T19:29:24.7587042-07:00" }, "Documents": [ { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4", "ZPL": "sample string 5", "PackageId": "sample string 6", "CustomerPackageId": "sample string 7" }, { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4", "ZPL": "sample string 5", "PackageId": "sample string 6", "CustomerPackageId": "sample string 7" } ], "TrackingNumbers": [ "sample string 1", "sample string 2" ], "TrackingURLs": [ "sample string 1", "sample string 2" ], "Status": "sample string 17", "IsBroker": true, "Email": "sample string 19" }, { "ShipmentId": "sample string 1", "QuoteId": "sample string 2", "IsCancelled": true, "Carrier": { "Id": 1, "Name": "sample string 2", "AccountNickName": "sample string 3", "Service": { "Id": 1, "Name": "sample string 2" }, "ScacCode": "sample string 4" }, "Rate": { "Id": "sample string 1", "Currency": "sample string 2", "DiscountedCost": 3.0, "ListCost": 4.0, "Service": "sample string 5", "TransitDays": "sample string 6", "MarkedUpCost": 7.0, "FreightCharge": 8.0, "AccessorialsCharge": 9.0, "FuelSurCharge": 10.0, "AccessorialBreakDown": [ { "Key": "sample string 1", "Value": 2.1 }, { "Key": "sample string 1", "Value": 2.1 } ] }, "PaymentTerm": 1, "ThirdPartyAccountInfo": { "AccountNumber": "sample string 1", "Address": "sample string 2", "City": "sample string 3", "Country": "sample string 4", "Email": "sample string 5", "Name": "sample string 6", "Phone": "sample string 7", "State": "sample string 8", "Zip": "sample string 9" }, "ShipDate": "2024-09-07T19:29:24.7567046-07:00", "ShipperAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ReturnAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ConsigneeAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" }, "ITN": "sample string 4", "Reference1": "sample string 5", "Reference2": "sample string 6", "Reference3": "sample string 7", "Reference4": "sample string 8", "Reference5": "sample string 9", "Reference6": "sample string 10", "Items": [ { "InnerPieces": { "PackageType": 1, "Quantity": 1, "ItemNumber": "sample string 2", "Length": 3.1, "Width": 4.1, "Height": 5.1, "Weight": 6.1, "Description": "sample string 7", "FreightClass": "sample string 8", "NMFC": "sample string 9", "Hazmat": true, "UnNumber": "sample string 11", "TechnicalName": "sample string 12", "Unit": 1 }, "Description": "sample string 1", "FreightClass": 2.1, "Height": 3.1, "Length": 4.1, "PackageType": 1, "Quantity": 5, "Weight": 6.1, "Unit": 1, "Width": 7.1, "PackageId": "sample string 8", "CustomerPackageId": "sample string 9" }, { "InnerPieces": { "PackageType": 1, "Quantity": 1, "ItemNumber": "sample string 2", "Length": 3.1, "Width": 4.1, "Height": 5.1, "Weight": 6.1, "Description": "sample string 7", "FreightClass": "sample string 8", "NMFC": "sample string 9", "Hazmat": true, "UnNumber": "sample string 11", "TechnicalName": "sample string 12", "Unit": 1 }, "Description": "sample string 1", "FreightClass": 2.1, "Height": 3.1, "Length": 4.1, "PackageType": 1, "Quantity": 5, "Weight": 6.1, "Unit": 1, "Width": 7.1, "PackageId": "sample string 8", "CustomerPackageId": "sample string 9" } ], "ProductDetails": [ { "Country": "sample string 1", "HTSCode": "sample string 2", "Description": "sample string 3", "Number": "sample string 4", "PackageId": "sample string 5", "PricePerPiece": 6.0, "PricePerPiece2": 7.0, "PricePerPiece3": 8.0, "PricePerPiece4": 9.0, "Quantity": 10, "Quantity2": 11, "Quantity3": 12, "Quantity4": 13, "Unit": "sample string 14", "OrderNumber": "sample string 15", "LineType": "sample string 16", "LineNumber": "sample string 17", "UPC": "sample string 18", "Category": "sample string 19", "SKU": "sample string 20", "TechnicalName": "sample string 21" }, { "Country": "sample string 1", "HTSCode": "sample string 2", "Description": "sample string 3", "Number": "sample string 4", "PackageId": "sample string 5", "PricePerPiece": 6.0, "PricePerPiece2": 7.0, "PricePerPiece3": 8.0, "PricePerPiece4": 9.0, "Quantity": 10, "Quantity2": 11, "Quantity3": 12, "Quantity4": 13, "Unit": "sample string 14", "OrderNumber": "sample string 15", "LineType": "sample string 16", "LineNumber": "sample string 17", "UPC": "sample string 18", "Category": "sample string 19", "SKU": "sample string 20", "TechnicalName": "sample string 21" } ], "AdditionalDetails": { "Accessorials": [ 1, 1 ], "CarrierInsuranceAmount": 1.0, "CODDetails": { "Amount": 1.0, "ChargeCode": "sample string 2", "PaymentType": 1, "RemitAddress": { "AttentionTo": "sample string 1", "City": "sample string 2", "CompanyId": "sample string 3", "Company": "sample string 4", "Country": "sample string 5", "Email": "sample string 6", "State": "sample string 7", "Street1": "sample string 8", "Street2": "sample string 9", "Phone": "sample string 10", "Zip": "sample string 11", "OrderType": "sample string 12" } }, "DeliveryConfirmation": 1, "HazmatEmergencyNo": "sample string 2", "HazmatContact": "sample string 3", "IsSaturdayDelivery": true, "IsDeliveryDutyPaid": true, "SpecialInstructions": "sample string 6", "PickupSpecialInstructions": "sample string 7", "Alcohol": true }, "PickupNumber": "sample string 11", "PickupDetails": { "ReadyDateTime": "sample string 1", "Emails": [ "sample string 1", "sample string 2" ], "CutoffDateTime": "sample string 2", "ScheduledShipDate": "2024-09-07T19:29:24.7587042-07:00" }, "Documents": [ { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4", "ZPL": "sample string 5", "PackageId": "sample string 6", "CustomerPackageId": "sample string 7" }, { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4", "ZPL": "sample string 5", "PackageId": "sample string 6", "CustomerPackageId": "sample string 7" } ], "TrackingNumbers": [ "sample string 1", "sample string 2" ], "TrackingURLs": [ "sample string 1", "sample string 2" ], "Status": "sample string 17", "IsBroker": true, "Email": "sample string 19" } ], "Code": 100, "Message": "sample string 1" }