Delivery Reporting

Find shipment detail data in the Shipium Console.

About delivery reporting and shipment search

To locate details about a shipment, you'll need to access the Shipium Console and navigate to Delivery Reporting and then Shipment Search.

You can use a variety of search parameters to find details about a shipment as noted in the individual sections that follow.

Search

Fields that can narrow your simple search include the:

  • date range of your shipment search;
  • fulfillment center, which you will select from a dropdown menu (you may choose All or a particular fulfillment center);
  • tenant, which you will select from a dropdown menu (you may choose All or a particular tenant);
  • label filter, which you will select from a dropdown menu (ONLY Shipments with Labels, ONLY Carrier Selections without Labels, or All Shipments); and
  • LTL filter, which enables you to include or exclude less than truckload (LTL) shipments (visibility of this filter is shipment-characteristic dependent).

You can enter a full or partial string that matches any of the search parameters in the following table into the search bar.

Search parameterDescription
Shipium Shipment IDA globally unique identifier (GUID) representing the Shipium shipment identifier
Shipium Label IDGUID representing the Shipium label identifier
CarrierThe carrier's name (e.g., usps, ups)
Service MethodString representing the configured service method name (e.g., fedex-ground-service-method)
Shipment TagAny additional tag your organization assigned to the shipment
Label StatusesSupported statuses include failover, failure, generated, label_created, manifest_failure, manifested, success, and voided.
Destination Postal CodeThe postal code of the shipment destination (e.g., 98110)
Custom Label ValueString representing any of the custom label values passed to Shipium on label creation
Carrier Selection IDGUID representing the Shipium carrier selection identifier
Fulfillment Context IDGUID representing the fulfillment context identifier
Order Product IDProduct identifier passed when creating the shipment
LTL Shipment IDGUID representing the LTL shipment identifier
Partner Shipment IDIdentifier passed to Shipium representing your organization's shipment identifier
Partner Reference IdentifierIdentifier passed to Shipium representing a free form reference identifier

Advanced search

You can use the advanced search parameters to narrow your search results.

  • Shipium Shipment ID. The Shipium shipment identifier
  • Shipium Label ID. The Shipium label identifier
  • Carrier / Service Method. The applicable carrier and service method for the shipment, which you'll select from a dropdown menu; you can select a carrier and all its service methods (or multiple carriers inclusive of all service methods) or individually multi-select service methods across carriers.
  • Shipment Tag. Any tag value you passed in the API request body
  • Include Partial Shipments. You can select True or False from the dropdown to filter partial shipments.
  • Label Statuses. The label status of your shipment, which you'll select from a dropdown menu. Status values include Success, Success Generated, Success Created, Success Manifested, Success Failover, Success Voided, Failure, and Success Manifest Failure.
  • Hazmat. You'll select the hazmat value from a dropdown menu. If the shipment contained hazardous materials, this value is True; if it did not contain hazardous materials, this value is False.
  • Destination Postal Code. The United States Postal Service postal code of the destination address
  • Destination Country. The country of the destination address, which you'll select from a dropdown menu
  • Custom Label Key. A string value serving as a key for a custom label value included in the API request body, with the custom label value represented by the key to be printed on the label
  • Custom Label Value. A string representing a custom label value passed in the API request body on label creation
  • Exclude Test Mode. You'll select the test mode value from a dropdown menu. If the shipment was generated in test mode, this value is True; if it was not generated in test mode, this value is False.
  • Only Show Returns. You'll select either True or False from a dropdown menu to filter return shipments.

Field definitions for simple and advanced search results

This section lists terms and descriptions associated with shipment search details within the Shipium platform. They are organized by the search detail categories that appear on the shipment search results screen:

Request details

Information provided in the Request Details section includes the address from which the package was shipped (origin) and the address to which the package was shipped (destination). Shipment details are also returned for a shipment search, including the type of shipment, the package's dimensions and weights, the desired delivery date, the shipped date timestamp, and other special shipping properties.

By toggling the carat next to API Request Body, you also can view the JSON request body for the API call.

TermDescription
Ship-FromThe address from which the package was shipped; the address is part of origin configuration.
Shipment DetailsDetails of the shipment, to follow:
TypeThe type of package; this value can be:

- Box
- Envelope
- Flat Pack
- Mailing Tube
- Parcel Pallet
DimensionsPhysical dimensions of the package
Billable WeightThe weight used on the rate table to select an estimated cost; the physical weight is configured by the carrier and is typically rounded up. Dimensional weight will be displayed if used for rate selection.
Dim (Dimensional) WeightDimweight is the amount of space a package occupies in relation to its actual weight, as defined by the carrier. This value is typically Length (l) x Width (w) x Height (h) / dimweight divisor.
Physical WeightThe physical weight of the package included in the API request body
Delivery Signature Option- If the option was not included in the API request body, the value is None.
- If the option was included in the API request body, values for the type of signature include:
- Signature
- Resident Signature
- Adult Signature
- Adult Resident Signature
Saturday Delivery- If Saturday delivery was included in the API request body, the value is True.
- If Saturday delivery was not included in the API request body, the value is False.
Desired Delivery Date (DDD)The DDD provided in the API request body; it is expressed in Coordinated Universal Time (UTC) in the time local to the user and in compliance with ISO 8601 standards.
Shipped Date TimestampThe date the shipment left the warehouse; the Shipped Date Timestamp is expressed in UTC in the time local to the user and in compliance with ISO 8601 standards.
Ship-ToThe commercial or residential address of the package recipient
API Request BodyThe API request body in JSON format

Label

The Label section includes a print preview of the shipping label along with a unique label identifier, label status, shipping price, carrier and service method for the shipment, and label properties. Shipment details are also returned for a shipment search, including the type of shipment, the package's dimensions and weights, the desired delivery date, the shipped date timestamp, and other special shipping properties.

You can download a ZPL version of the label, print the label, or cancel a shipment from this section.

TermDescription
Label IDThe Shipium unique label identifier
StatusThe status of the shipment label. This value can be:

- Success
- Failed
- Void
Status DetailThe status detail of the shipment label. This value can be:

- Success Created
- Success Failover
- Success Test Mode
- Failed
- Void
PriceThe Shipium estimated cost for the shipment, based on the carrier
Service NameThe carrier and service method for the shipment
dpi/dpmmThe resolution of the label printing:

- dpi = dots per inch
- dpmm = dots per millimeter
WidthThe width of the label, in inches
HeightThe height of the label, in inches
OrientationThe rotation applied to the label; the default value is 0 (zero).
Label ExpirationThe Shipium estimated date of label expiration
Right-Side MenuThe menu options at right, to follow:
InfoThe information detailed above from the primary Label screen
RequestThe label request payload
ResponseThe label request response
ZPLThe label request in ZPL format
RawThe raw label request
LabelA printing preview of the label

Shipment order items

Information in the Shipment Order Items section includes a unique product identifier for the shipment, the order quantity, any product tags assigned by your organization, and an indicator for hazardous materials in the order. This section also includes other unique identifiers for the shipment order, such as Shipium Order ID.

TermDescription
Delivery Estimate IDA Shipium ID from the estimate provided by Delivery Promise; the default value is Not Applicable (N/A).
Shipium Order IDA Shipium ID of a group of delivery estimates purchased, provided by Delivery Promise; the default value is N/A.
Partner Order IDAn order ID included in the API request body; the default value is N/A.
Product IDThe product ID passed in the API request body
QuantityThe number of items in the shipment
Product TagsAny tags passed in the API request body
Hazmat (Hazardous Materials)- If hazmat was indicated in the API request body, the value is True. - If hazmat was not indicated in the API request body, the value is False.

Rate selection results

The Rate Selection Results section includes the carrier and service method selected for the shipment, the shipment effective date, shipment weights, a delivery zone identifier, a Shipium modeled total calculated cost, and a breakdown of cost elements.

TermDescription
Carrier SelectedThe carrier selected to transport the package
Method SelectedThe service method selected to transport the package
Shipment Effective DateThe first date that the request can be shipped; the date is determined by the value passed in the API request body, plus the configuration for your organization's account (e.g., weekends, holidays, carrier schedule).
Billable WeightThe weight used on the rate table to select an estimated cost; the physical weight is configured by the carrier and is typically rounded up. Dimensional weight will be displayed if used for rate selection.
Dim (Dimensional) WeightDimweight is the amount of space a package occupies in relation to its actual weight, as defined by the carrier. This value is typically Length (l) x Width (w) x Height (h) / dimweight divisor.
Physical WeightThe physical weight of the package included in the API request body
Zone IDThe Shipium delivery zone as defined by the carrier-identified zone
Calculated CostThe Shipium modeled total cost of the shipment estimated by your organization's account configuration and carrier contract
Cost ElementsBreakdown of the calculated cost, to follow:
Base Rate (Base)The rate table (weight to zone)
SurchargesAny additional carrier costs associated with the shipment; surcharges apply globally.
Surcharge ModifiersAny discounts applied to the surcharges, as established in your organization's carrier contract; you also may have custom surcharge modifiers configured.

Service method

The Service Method section provides details about the carriers and service methods that were evaluated but not selected for a shipment. Information includes a Shipium modeled cost of the shipment, the estimated delivery date, and the selection status for each carrier and service method. The selection status provides a reason why the carrier and service method were not selected.

TermDescription
Service MethodThe carrier service method
CostThe Shipium modeled cost of the shipment
Estimated Delivery (DDD)The Shipium predicted date for a delivery at product checkout, based on time-in-transit values; the clock icon at the top of the column enables you to change time zones.
Selection StatusThe status of the carrier service method evaluated for the requested shipment; the reason for each method that was not selected is provided. This value can be:

- Selected - Label Created
- Selected - Carrier Error
- Failover - Label Created
- Evaluated (met shipment criteria passed in the API request body but not the least expensive service method)
- Filtered (did not meet shipment criteria passed in the API request body; reason provided)

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful: