POST shipment/shipWithQuote
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.
EndPoint
Production Url: https://enterprise.freightpop.com/shipment/shipWithQuoteSandbox Url: https://sandbox-api.freightpop.com/shipment/shipWithQuote
Request Information
URI Parameters
None.
Body Parameters
Shipment request object.
ShipmentRequestName | Description | Type | Additional information |
---|---|---|---|
QuoteId |
Quote Id to be used for shipment. Id is provided in RateResponse |
string |
None. |
RateId |
Id of a rate to be used for shipment. Id provided in RateResponse. |
string |
None. |
ShipDate |
Ship date in UTC |
date |
None. |
ShipperAddress |
Shipper address |
ShipmentAddress |
None. |
ReturnAddress |
Return Address |
Address |
None. |
IncludeReturnLabel |
Include parcel return label |
boolean |
None. |
ConsigneeAddress |
Consignee address |
ShipmentAddress |
None. |
Reference1 |
Reference 1 |
string |
None. |
Reference2 |
Referece 2 |
string |
None. |
Reference3 |
Referece 3 |
string |
None. |
Reference4 |
Referece 4 |
string |
None. |
Reference5 |
Referece 5 |
string |
None. |
Reference6 |
Referece 6 |
string |
None. |
ProductDetails |
Product details |
Collection of ProductDetail |
None. |
ITN |
International transaction number |
string |
None. |
PickupDetails |
Pickup details |
PickupDetails |
None. |
AdditionalDetails |
Additional details |
AdditionalDetails |
None. |
ZPLLabel |
Options 4x6ForAllThatApply, FedEx4x4.675 or UPS4x8 |
ZPLLabel |
Optional
|
Request Formats
application/json, text/json
{ "QuoteId": "sample string 1", "RateId": "sample string 2", "ShipDate": "2024-09-07T19:32:41.4892173-07:00", "ShipperAddress": { "CompanyId": "sample string 1", "AttentionTo": "sample string 2", "Company": "sample string 3", "Email": "sample string 4", "Phone": "sample string 5", "Street1": "sample string 6", "Street2": "sample string 7", "City": "sample string 8", "Country": "sample string 9", "State": "sample string 10", "Zip": "sample string 11" }, "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" }, "IncludeReturnLabel": true, "ConsigneeAddress": { "CompanyId": "sample string 1", "AttentionTo": "sample string 2", "Company": "sample string 3", "Email": "sample string 4", "Phone": "sample string 5", "Street1": "sample string 6", "Street2": "sample string 7", "City": "sample string 8", "Country": "sample string 9", "State": "sample string 10", "Zip": "sample string 11" }, "Reference1": "sample string 4", "Reference2": "sample string 5", "Reference3": "sample string 6", "Reference4": "sample string 7", "Reference5": "sample string 8", "Reference6": "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" } ], "ITN": "sample string 10", "PickupDetails": { "ReadyDateTime": "2024-09-07T19:32:41.4892173-07:00", "Emails": [ "sample string 1", "sample string 2" ], "CutoffDateTime": "2024-09-07T19:32:41.4892173-07:00" }, "AdditionalDetails": { "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 }, "ZPLLabel": 0 }
Response Information
Resource Description
ShipmentResponseName | Description | Type | Additional information |
---|---|---|---|
Data |
Shipment response object info |
ShipmentResponseObject |
None. |
Code |
Response code returned by api |
HttpStatusCode |
None. |
Message |
Human readable message |
string |
None. |
Response Formats
application/json, text/json
{ "Data": { "RateId": "sample string 1", "ShipmentId": "sample string 2", "QuoteAmount": "sample string 3", "Documents": [ { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4" }, { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4" } ], "ZPLDocuments": [ { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4" }, { "Type": "sample string 1", "Format": "sample string 2", "Url": "sample string 3", "Number": "sample string 4" } ], "TrackingNumbers": [ "sample string 1", "sample string 2" ], "PickupNumber": "sample string 4", "Errors": [ "sample string 1", "sample string 2" ] }, "Code": 100, "Message": "sample string 1" }