🔑 Parcel Perform Get Shipment by Field
Uses the Parcel Perform List Shipments endpoint to access information about a Parcel Perform Shipment (via searching a valid field_name and field_value).
Note: searches are filtered to shipments with latest updates within the past year.
Valid Field Names: tracking_number, shipment_reference, additional_reference, order_uuid, order_id, order_reference, carrier_id, carrier_reference, status, current_phase, tags, notification_email, notification_phone, tracking_page_reference, from_country_code, to_country_code, linked_shipments, issue_state, issue_types, shipping_type.
API Documentation here.
Inputs
| Name | Type | Description |
|---|---|---|
| Parcel Perform Client ID | SensitiveString | Parcel Perform Client ID |
| Parcel Perform Client Secret | SensitiveString | Parcel Perform Client Secret |
| Field Name | String | Field Name (e.g tracking_number) |
| Field Value | String | Field Value (e.g 0123456789) |
Outputs
| Name | Type | Description |
|---|---|---|
| Shipment Found? | Boolean | Shipment Found? |
| Message | String | Response Message |
| Shipment Data | Object | Shipment Data Object |
| Shipment UUID | String | Shipment UUID |
| Shipment ID | String | Shipment ID |
| Shipment Tracking Number | String | Shipment Tracking Number |
| Shipment Carrier | String | Shipment Carrier |
| Shipment Status | String | Shipment Status |
| Shipment Current Phase | Object | Shipment Current Phase |
| Shipment Created Date | String | Shipment Created Date |
| Shipment Updated Date | String | Shipment Updated Date |
| Shipment Order | Object | Shipment Order |
| Shipment Latest Event | Object | Shipment Latest Event |
| Number of Shipments | Number | Number of Shipments Found |
Updated 3 months ago