QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
OTHER
Store Slug
Minimum Valid Parsing Result
Reference
API Overview
v1
Email Parses
Parse an email V2
post
Parse an email
post
Model
Envelope
Meta
v1
Error
v1
Primitive V2
Phone V2
v2
Store V2
v2
Address V2
v2
OrderItem V2
v2
Money V2
v2
Tracking V2
v2
Order V2
v2
EstimatedDeliveryDate
v2
EstimatedDeliveryDateTime
v2
ShippingMethod V2
v2
DateTime V2
v2
Header
v1
Primitive V1
Phone
v1
Store
v1
Address
v1
EstimatedDeliveryDate
v1
EstimatedDeliveryDateTime
v1
ShippingMethod
v1
OrderItem
v1
Money
v1
DateTime
v1
Tracking
v1
Order
v1
Support
Contact Support

Minimum Valid Parsing Result

There is a concept of minimum valid parsing results in the AfterShip Parser API. The email parsing would need to meet the conditions of the minimum valid parsing results in order for the API to return any results.

email-parses-v2

In V2 API, the definition of the minimum valid parsing result is to return at least either order.number OR order.trackings.tracking_number.

Here are some sample responses of the minimum valid parsing result returned by V2 API:

Example 1Example 2Example 3
order.number onlyorder.trackings.tracking_number onlyorder.number and
order.trackings.tracking_number

email-parses

In V1 API, the definition of the minimum valid parsing result is to return at least order.order_number + order.store OR order.trackings.tracking_number.

Here are some sample responses of the minimum valid parsing result returned by V1 API:

Example 1Example 2Example 3
order.order_number + order.storeorder.trackings.tracking_number onlyorder.order_number + order.store + order.trackings.tracking_number