Inferences
Retrieve shipping labels
Once you have scan the shipping label, you can query for them in the API. If you have the developer or owner role, you're able to also view the scans on your dashboard at https://cloud.packagex.io/inferences/shipping-labels.
Retrieve Scan
Get a single scan using its id
.
List Shipping-Labels
Example
When you want to retrieve multiple shipping-labels, your data
property on the result will always be an array
even if you don't have any shipping-labels. The shipping-labels are returned in descending order, meaning the latest scan that was created will be first.
Pagination
If the has_more
property on the pagination object is set to true, you know there are more scans in the database that have not been returned to you. The pagination object also has a page
property indicating your current offset and a limit property. The total_count property in pagination returns the the total number of scans in the database.
By default the page
is set to 1
and the limit
is 10
.
If we want to query for scans 11 - 20, we would request page 2 with a query parameter.
Filter
- Location Filtering
- Scans with a
location_id
property can be filtered by location.
- Provider filtering:
- You can now filter by
provider_name
.
- Service level filtering:
- Filtering options include
service_level_name
.
Similarly we can also filter on date and package status.
Status
Date
Search
There are times when filtering is not enough and you want to find a specific inference by some other attribute. In this case, you can do a fuzzy, typo-tolerant search of every inference in the database.
Below are the properties that are supported by our full text search.
Searchable Properties
search.sender
: the sender name, email and businesssearch.recipient
: the recipient name, email and businesssearch.order_number
search.tracking_number
search.rma_number
search.reference_number
search.invoice_number
search.purchase_order
search.barcode_values
search.metadata
: the custom metadata of the shipping label inference
To perform a general search, simply provide a string to search by using the search
query param. The results will be order by the most relevant first.
To perform a targeted search, or a mixture of targeted search and general search, or to use various modifiers to boost a particular field, refer to the general section on search, while using the searchable properties provided above
We provide a _searchV2
object that has a searchV2.scores
property for scores and searchV2.shipping_label_inference
property with all matches highlighted with <mark>
handles; this object has the same structure as the shipping label inference object, except only those properties are present where there are highlights.
Ordering Search Results
By default, search results are ordered by relevance. However, if you include an order_by
parameter along with your search query, the results will be ordered by the specified property instead of by relevance.
Relevance Score
Relevance scores are included in the search results by default. Note that this could add up to 10ms of extra time to the request.