Scans

Models

Scan Model

The scan 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 "scan"
The description of the model.

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

contact_matches Object
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.

Show Details


contact_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`.
contact_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`.

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.

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

hash string
A unique hash for this scan that can be used to identify duplicate scans.

id string
Unique identifier for the scan.

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

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 scan.

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

provider_name string
The name of the shipping provider.

purchase_order string
Any extracted purchase order numbers from the scan.

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

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.

reference_number string
Any extracted reference number from the scan.

rma_number string
Return material authorization if included 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. 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.

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

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

type string
The type of scan that was selected. Defaults to shipping_label, and other options currently include manifest, invoice, inventory.

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

Models

# Scan Model

Scan Model