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.

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.

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

metadata object
Key value pairs of data that you can set for this 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.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.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.

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",
  • "multiple_matches",
  • "missing_matches",
  • "server_error",
  • "duplicate",
  • "missing_location",
  • "inference_missing_value",
  • "match_missing_value",
  • "invalid_model_keys",
  • "missing_rate_id",
Previous <- Inferences Overview
Next Events ->