1. Scans
  2. Models

Scans

Models

Scan Model

The scan represents a single image that was scanned and data extracted.


object "scan"
The description of the model.

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

id string
Unique identifier for the scan.

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

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

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 object
Details about the shipping provider.

Show Details
provider.id string
Unique ID for the provider.
provider.logo_url string
Logo of the provider.
provider.marketplace boolean
If this shipping provider came from the PackageX marketplace.
provider.name string
Name of the provider.
provider.support_email string
Email to contact support for this provider, available for on demand couriers.
provider.support_phone string
Phone to contact support for this provider, available for on demand couriers.
provider.support_url string
URL to contact support for this provider, available for on demand couriers.
provider.support_reference string
A support reference code that some providers use to help customers.

purchase_order string
Any extracted purchase order numbers from the scan.

raw 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 shipping label

reference_number string
Any extracted reference number from the scan.

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.id string
The organization ID of the sender.
sender.logo_url string
The logo 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 shipping label

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.