1. Inferences
  2. Models

Inferences

Models

Shipping Label Model

The shipping-label represents a single image that was scanned and data extracted.

EXPERIMENTAL

Extracting the weight and dimension values is still experimental. We not only want to extract the raw strings, but also parse them into meaningful numbers that you can use.

object "shipping_label_inference"
The description of the model.

raw_text string
The raw text that was extracted from the image with the OCR before being added to the model.

created_at integer
Time in epoch seconds when this scan was created.

updated_at integer
Time in epoch seconds when this scan was last updated.

created_by string
The ID of the user or API key that created this inference.

updated_by string
The ID of the user or API key that last updated this inference.

hash string
A unique hash for this shipping-label that can be used to identify duplicate scanned labels.

id string
Unique identifier for the shipping-label.

image_url string
The URL to the image used for this shipping-label.

media_urls Array<string>
Media URLs associated with the inference.

location_id string
The hub location to which this delivery is assigned.

destination_location object nullable
When inbound multi-hop rerouting is enabled and the recipient is matched at a different location, this object contains the ID of the destination location where the package should be rerouted to. null when rerouting is not applicable.

Show Details
destination_location.id string
The ID of the destination location for this reroute.

layout object
Details of the layout of the specified location

metadata object
Key value pairs of data that you can set for this shipping-label.

notes string
Notes associated with this shipping-label inference.

account_id string
The account ID associated with this inference.

invoice_number string
The invoice number extracted from the shipping-label.

order_number string
The order number extracted from the shipping-label.

organization_id string
Unique identifier for the organization that owns this shipping-label. This will always be your organization ID.

recipient object
Details about the contact receiving this delivery.

Show Details
recipient.address Address
The parsed address for this recipient.
recipient.email string
Email for the recipient. Recipient will receive tracking notifications here.
recipient.phone string
Phone number of the recipient. On demand couriers may contact this number for issues.
recipient.name string
Name of the recipient, printed on the document.
recipient.business string
Name of the recipient business, printed on the document.
recipient.contact_id string
The ID of the contact if one was used to create this recipient.

sender object
Details about the contact sending this delivery.

Show Details
sender.address Address
Parsed address for the sender.
sender.email string
Email for the sender.
sender.phone string
Phone number of the sender. On demand couriers may contact this number for issues.
sender.name string
Name of the sender, printed on the document.
sender.business string
Name of the sender business, printed on the document.
sender.contact_id string
The ID of the contact if one was used to create this sender.

provider_name string
The name of the shipping provider.

providers Array<provider>
List of extracted providers, min 1, max 2.

provider object
Based on postprocess.provider_selection option
use_first - First from providers list
use_last - Last from providers list
select - null values, representing user needs to select a provider

Show Details
provider.id string
Identifier for shipping provider.
provider.name string
The name of the shipping provider.
provider.service_level.id string
Service level identifier.
provider.service_level.name string
The name of the service level for this package.
provider.provider_service_level.id string
Carrier-specific service level code.
provider.tracking_number string
Provider-specific string used to track this delivery.
provider.tracking_number_barcode string
Tracking number barcode.

barcode_listArray.<String>
List of other barcodes, not necessarily tracking ones, extracted from the shipping label.

service_level_name string
The name of the service level for this package.

tracking_number string
Provider-specific string used to track this delivery.

purchase_order string
Any extracted purchase order numbers from the shipping-label.

reference_number string
Any extracted reference number from the shipping-label.

rma_number string
Return material authorization if included on the document.

extracted_labels Array.<String>
A list of all labels extracted from the document. Options include: perishable, legal_document, pay_stub, confidential, fragile, oversized, time_sensitive, return_to_sender, alcohol, lithium, cannabis, dry_cleaning

weight string
The weight in pounds of the item that was scanned, if exists.

dimensions object
The dimensions in inches of the item that was scanned, if they exist.

Show Details
dimensions.length number
The length in inches.
dimensions.width number
The width in inches.
dimensions.height number
The height in inches.

matches Object
Lists of contacts who have been matched to senders and recipients for the shipping-label if the match_contacts was set to true when creating the scan.

Show Details
matches.senders Contact
All of the contacts that have matched the sender. You may be interested in the relevance score of the match found in contact._search.relevance_score.
matches.recipients Contact
All of the contacts that have matched the recipient. You may be interested in the relevance score of the match found in contact._search.relevance_score.

errors Array.<String>
The list of errors, the possible values are:

  • "no_matches",
  • "partial_matches",
  • "multiple_matches",
  • "missing_matches",
  • "server_error",
  • "duplicate",
  • "missing_location",
  • "inference_missing_value",
  • "match_missing_value",
  • "invalid_model_keys",
  • "missing_rate_id",
  • "multiple_providers",
  • "destination_location_unknown",
  • "child_shipments_not_found",
  • "child_shipments_location_mismatch",
  • "child_shipments_status_not_allowed",
  • "child_shipments_trackers_overlap",

exceptions object
An object of exception flags. When any exception is true, the inference status is set to exception and requires operator action to resolve.

Show Details
exceptions.unknown_contact boolean
The matched contact could not be identified.
exceptions.addressed_generically boolean
The label is addressed generically (e.g. "Resident").
exceptions.damaged_label boolean
The shipping label is damaged or unreadable.
exceptions.arrived_opened boolean
The package arrived opened or tampered with.
exceptions.suspicious boolean
The package is flagged as suspicious.
exceptions.missing_label boolean
The package has no shipping label.
exceptions.multiple_shipments boolean
The scanned package matches a parent shipment with child shipments. Operator must process each child individually.
exceptions.missing_parent_shipment boolean
A child shipment was scanned but the parent shipment has not been scanned yet at this location.

logs Array<object>
A list of log entries associated with this inference.

Show Details
logs[].id string
Unique identifier for the log entry.
logs[].message string
The log message content.
logs[].visibility string
Visibility level of the log entry.
logs[].images Array<string>
Image URLs attached to the log entry.
logs[].created_at integer
Time in epoch seconds when the log entry was created.
logs[].created_by string
The ID of the user or API key that created the log entry.

_searchV2 object
A special property that will be included if searching through inferences.

Show Details
_search.scores Scores
An object representing the various scores calculated
_search.shipping_label_inference object
This is a subset of the Shipping Label Inference model that will only include those properties where there is some matched content which will include <mark> tags around characters that have matched the search. You can use this to more easily highlight text for a user interface.

additional_attributes array

A list of additional attributes related to the Shipping Label. Each object in the list is an object containing key-value pairs. These are those key value pairs which are present on the scanned label but not part of the object above

Show Details

Each object in additional_attributes may contain different key-value pairs. Examples include:

        [
  {
    "shipmentDate": "2025-08-12"
  },
  {
    "manufacturingCountry": "Brazil"
  }
]

tracker_id string nullable
The ID of the tracker associated with this inference. Set when the inference is transformed into a tracker.

child_shipments Array<string>
Array of shipment IDs that are children of the parent shipment created by this inference. Only applicable for outbound inferences with child shipments. Empty array if no children.

tags Array<string>
An array of tags associated with this inference.

tracker object nullable
The tracker associated with this inference, if one exists. Includes linked child and parent tracker references when the tracker is part of a parent-child shipment hierarchy.

Show Details
tracker.id string
The ID of the associated tracker.
tracker.child_trackers Array<object> nullable
When the tracker contains a parent shipment, lists the trackers of child shipments. null if the tracker is not a parent.
tracker.child_trackers[].id string
The ID of the child tracker.
tracker.parent_tracker object nullable
When the tracker contains a child shipment linked to a parent, references the parent's tracker. null when the tracker is not a child.
tracker.parent_tracker.id string
The ID of the parent tracker.

Bill Of Lading Model

object "bill_of_lading_inference"
The description of the model.

raw_text string
The raw text that was extracted from the image with the OCR before being added to the model.

created_at integer
Time in epoch seconds when this scan was created.

checksum string
A unique hash for this BOL that can be used to identify duplicate scanned labels.

id string
Unique identifier for the BOL.

image_url string
The URL to the image used for this BOL.

location_id string
The hub location to which this scanned BOL was assigned.

metadata object
Key value pairs of data that you can set for this BOL.

organization_id string
Unique identifier for the organization that owns this BOL. This will always be your organization ID.

recipient object
Details about the contact receiving this delivery.

Show Details
recipient.address Address
The parsed address for this recipient.
recipient.email string
Email for the recipient.
recipient.phone string
Phone number of the recipient.
recipient.name string
Name of the recipient, printed on the document.
recipient.business string
Name of the recipient business, printed on the document.

sender object
Details about the contact sending this delivery.

Show Details
sender.address Address
Parsed address for the sender.
sender.email string
Email for the sender.
sender.phone string
Phone number of the sender.
sender.name string
Name of the sender, printed on the document.
sender.business string
Name of the sender business, printed on the document.

tables object
The tables object represents a structured list of tables, where each table consists of multiple items. Each item is a collection of key-value pairs that define specific attributes.

Show Details

Structure

The tables object is a list of tables, where:

  • Each table is a list of items.
  • Each item is an object containing key-value pairs that represent attributes such as quantity, description, or other relevant details.
Example
        "tables": [
  [
    {
      "QTY": "SIDE",
      "DESCRIPTION OF GOODS": "item 1"
    },
    {
      "QTY": "250",
      "DESCRIPTION OF GOODS": "item 2"
    }
  ]
]

logistics_attributes object

Details about the logistics information associated with this BOL.

Show Details
logistics_attributes.house_bill_of_lading string | null
Unique identifier for the house bill of lading.
logistics_attributes.line_bill_of_lading string | null
Unique identifier for the line bill of lading.
logistics_attributes.master_bill_of_lading string | null
Unique identifier for the master bill of lading, if available.
logistics_attributes.invoice_number string | null
Invoice number associated with the shipment, if available.
logistics_attributes.order_number string
Order number related to this shipment.
logistics_attributes.purchase_order_number string | null
Purchase order number, if applicable.
logistics_attributes.reference_number string | null
Reference number associated with the shipment.
logistics_attributes.customer_purchase_order_number string | null
Customer-provided purchase order number, if applicable.
logistics_attributes.container_number string | null
Container number associated with the shipment, if applicable.
logistics_attributes.load_number string | null
Load number associated with the shipment, if applicable.
logistics_attributes.shipping_id string | null
Shipping ID associated with the shipment.
logistics_attributes.shipping_date object
The date when the shipment is scheduled.
logistics_attributes.shipping_date.year integer | null
The year of the shipping date, if available.
logistics_attributes.shipping_date.month integer | null
The month of the shipping date, if available.
logistics_attributes.shipping_date.day integer | null
The day of the shipping date, if available.

Item Label Model

object "item_label_inference"
The description of the model.

raw_text string
The raw text that was extracted from the image with the OCR before being added to the model.

created_at integer
Time in epoch seconds when this scan was created.

checksum string
A unique hash for this item label that can be used to identify duplicate scanned labels.

id string
Unique identifier for the item label.

image_url string
The URL to the image used for this item label.

location_id string
The hub location to which this scanned item label was assigned.

metadata object
Key value pairs of data that you can set for this item label.

organization_id string
Unique identifier for the organization that owns this item label. This will always be your organization ID.

recipient object
Details about the contact receiving this delivery.

Show Details
recipient.address Address
The parsed address for this recipient.
recipient.email string
Email for the recipient.
recipient.phone string
Phone number of the recipient.
recipient.name string
Name of the recipient, printed on the document.
recipient.business string
Name of the recipient business, printed on the document.

sender object
Details about the contact sending this delivery.

Show Details
sender.address Address
Parsed address for the sender.
sender.email string
Email for the sender.
sender.phone string
Phone number of the sender.
sender.name string
Name of the sender, printed on the document.
sender.business string
Name of the sender business, printed on the document.

customer object

Contains customer-related information.

Show Details
Field Type Description
customer.sku string Customer SKU printed on label

item object

Contains details of the item on the label.

Show Details
Field Type Description
item.sku string SKU of the item.
item.name string Name of the item.
item.numbers string Identification numbers related to the item.
item.quantity integer Quantity of the item in the shipment.
item.dimensions object Dimensions of the item.
item.dimensions.length object Length of the item.
item.dimensions.length.value number Value of the length.
item.dimensions.length.unit string Unit of measurement for length.
item.dimensions.width object Width of the item.
item.dimensions.width.value number Value of the width.
item.dimensions.width.unit string Unit of measurement for width.
item.dimensions.height object Height of the item.
item.dimensions.height.value number Value of the height.
item.dimensions.height.unit string Unit of measurement for height.
item.weight object Weight of the item.
item.weight.value number Weight value of the item.
item.weight.unit string Unit of measurement for weight.
item.volume object Volume of the item.
item.volume.value number Volume value of the item.
item.volume.unit string Unit of measurement for volume.
item.color string Color of the item.
item.model string Model identifier of the item.
item.upc string UPC (Universal Product Code) of the item.
item.gtin string GTIN (Global Trade Item Number) of the item.
item.version string Version of the item.
item.season string Season information of the item.
item.mac_address string MAC address if the item is a device.

package object

Contains package-related information.

Show Details
Field Type Description
package.dimensions object Dimensions of the package.
package.dimensions.length object Length of the package.
package.dimensions.length.value number Value of the length.
package.dimensions.length.unit string Unit of measurement for length.
package.dimensions.width object Width of the package.
package.dimensions.width.value number Value of the width.
package.dimensions.width.unit string Unit of measurement for width.
package.dimensions.height object Height of the package.
package.dimensions.height.value number Value of the height.
package.dimensions.height.unit string Unit of measurement for height.
package.weight object Weight of the package.
package.weight.value number Weight value of the package.
package.weight.unit string Unit of measurement for weight.
package.volume object Volume of the package.
package.volume.value number Volume value of the package.
package.volume.unit string Unit of measurement for volume.

pallet object

Contains pallet-related information.

Show Details
Field Type Description
pallet.id string Identifier for the pallet.
pallet.number string Number associated with the pallet.

carton object

Contains carton-related information.

Show Details
Field Type Description
carton.number string Number associated with the carton.

lot object

Contains lot-related information.

Show Details
Field Type Description
lot.number string The lot Number of the scanned label of the items.

barcode_values array

List of barcode values associated with the scanned item label.

purchase_orders array

List of purchase orders associated with the scanned item label.

sales_orders array

List of sales orders associated with the scanned item label.

serial_numbers array

List of serial numbers associated with the scanned item label.

origin object

Contains origin-related information.

Show Details
Field Type Description
origin.country string Country of origin for the scanned item label.

dates object

Contains manufacturing and expiry dates.

Show Details
Field Type Description
dates.manufacturing object Manufacturing date of the item.
dates.manufacturing.year number Year of manufacturing.
dates.manufacturing.month number Month of manufacturing.
dates.manufacturing.day number Day of manufacturing.
dates.expiry object Expiry date of the item.
dates.expiry.year number Year of expiry.
dates.expiry.month number Month of expiry.
dates.expiry.day number Day of expiry.

additional_attributes array

A list of additional attributes related to the item. Each item in the list is an object containing key-value pairs. These are those key value pairs which are present on the scanned label but not part of the object above

Show Details

Each object in additional_attributes may contain different key-value pairs. Examples include:

        [
  {
    "customerName": "Zain Ali"
  },
  {
    "ContainerNumber": 12345
  }
]

Previous <- Inferences Overview
Next Events ->