The scan represents a single image that was scanned and data extracted.
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.
The description of the model.
Time in epoch seconds when this scan was created.
Lists of contacts who have been matched to senders and recipients for the scan if the match_contacts was set to true when creating the scan.
All of the contacts that have matched the sender. You may be interested in the relevance score of the match found in
All of the contacts that have matched the recipient. You may be interested in the relevance score of the match found in
The dimensions in inches of the item that was scanned, if they exist.
The length in inches.
The width in inches.
The height in inches.
A list of all labels extracted from the document. Options include:
A unique hash for this scan that can be used to identify duplicate scans.
Unique identifier for the scan.
The URL to the image used for this scan.
The hub location to which this delivery is assigned.
Key value pairs of data that you can set for this scan.
Unique identifier for the organization that owns this scan. This will always be your organization ID.
The name of the shipping provider.
Any extracted purchase order numbers from the scan.
The raw text that was extracted from the image with the OCR before being added to the model.
Details about the contact receiving this delivery.
The parsed address for this recipient.
Email for the recipient. Recipient will receive tracking notifications here.
Phone number of the recipient. On demand couriers may contact this number for issues.
Name of the recipient, printed on the document.
The ID of the contact if one was used to create this recipient.
Any extracted reference number from the scan.
Return material authorization if included on the document.
Details about the contact sending this delivery.
Parsed address for the sender.
Email for the sender.
Phone number of the sender. On demand couriers may contact this number for issues.
Name of the sender, printed on the document.
The ID of the contact if one was used to create this sender.
The name of the service level for this package.
Provider-specific string used to track this delivery.
The type of scan that was selected. Defaults to
shipping_label, and other options currently include
The weight in pounds of the item that was scanned, if exists.