Version 4.0.0 of project44's API
License © 2024 project44 - Terms of Use
Version 4.0.0 of project44's API
parcelShipment
Contains fields used to configure the Parcel shipment API.
The requested capacity provider account group containing the account used for authentication with the capacity provider's API.
The project44-generated id for the shipment. This may not be provided when creating a shipment, but will always be returned in the shipment confirmation. This id may be used in subsequent API calls to reference a shipment.
The project44-generated id for the shipment. This ID may be used when this shipment passes between different modes.This may not be provided when creating a shipment, but will always be returned in the shipment confirmation.
Identifies the leg of the journey. Each piece of equipment has a unique id for each mode that it travels on.This id may be used in subsequent API calls to reference this shipment leg.
A user-defined list of shipment attributes that are associated with the shipment
A user-defined list of shipment identifiers that are unique to this shipment and carrier identifier. These may be used in subsequent API calls along with the carrier identifier to reference a shipment. They may also be used by project44 to track the shipment. Only one shipment identifier of each type may be provided. Currently, parcel tracking only accepts shipment identifier with type 'TRACKING_NUMBER'.
curl -i -X POST \ https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/parcel/shipments \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "apiConfiguration": { "fallBackToDefaultAccountGroup": true }, "capacityProviderAccountGroup": { "code": "string", "accounts": [ { "code": "string" } ] }, "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "parcelLegId": "1e90839f-77bf-4c7b-bf18-95a33ad4ed86", "shipmentAttributes": [ { "name": "string", "values": [ "string" ] } ], "shipmentIdentifiers": [ { "type": "TRACKING_NUMBER", "value": "string" } ], "shipmentStops": [ { "appointmentWindow": { "startDateTime": "2019-08-24T14:15:22Z", "endDateTime": "2019-08-24T14:15:22Z", "localTimeZoneIdentifier": "string" }, "id": 0, "location": { "address": { "postalCode": "string", "addressLines": [ "str" ], "city": "string", "state": "string", "country": "US" }, "contact": { "companyName": "string", "contactName": "string", "phoneNumber": "string", "phoneNumberCountryCode": "string", "phoneNumber2": "string", "phoneNumber2CountryCode": "string", "email": "string", "faxNumber": "string", "faxNumberCountryCode": "string" }, "geoCoordinates": { "latitude": -90, "longitude": -180 } }, "parcelShipmentStopType": "ORIGIN" } ] }'
OK
System messages and messages from the capacity provider with severity 'INFO' or 'WARNING'. No messages with severity 'ERROR' will be returned here.
The created shipment or shipments, including project44-calculated shipment stop details and the project44 id of the shipment. This will contain all shipments that were created including the one originally requested. If this is a multi-package shipment additional shipments will be created, one for each package.
{ "infoMessages": [ { … } ], "shipment": { "apiConfiguration": { … }, "capacityProviderAccountGroup": { … }, "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "parcelLegId": "1e90839f-77bf-4c7b-bf18-95a33ad4ed86", "shipmentAttributes": [ … ], "shipmentIdentifiers": [ … ], "shipmentStops": [ … ] }, "shipments": [ { … } ] }
curl -i -X DELETE \ 'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/parcel/shipments/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "infoMessages": [ { … } ] }
curl -i -X GET \ 'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/parcel/shipments/{id}/statuses?includeStatusHistory=true' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "latestStatusUpdate": { "address": { … }, "appointmentWindow": { … }, "geoCoordinates": { … }, "localTimeZone": "string", "retrievalDateTime": "string", "statusCode": "INFO", "statusReason": { … }, "stopId": 0, "stopType": "ORIGIN", "timestamp": "string" }, "shipment": { "actualDeliveryTimestamp": "string", "createdAtTimestamp": "string", "estimatedDeliveryTimestamp": "string", "id": 0, "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "parcelLegId": "1e90839f-77bf-4c7b-bf18-95a33ad4ed86", "pickedUpTimestamp": "string", "shipmentAttributes": [ … ], "shipmentIdentifiers": [ … ], "shipmentStops": [ … ] }, "statusUpdates": [ { … } ] }