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

Parse an email V2

post
/email-parses-v2

Parse orders and tracking detail from an email.

AfterShip Parser only returns parsing results that meet the conditions of the minimum valid parsing results during parsing. See Minimum Valid Parsing Result.

The size of the Request Body must be at most 27MB.

Request

Body

headers
array[EmailHeader]
required

Email headers in the raw email data. It is recommended to pass all headers for improving the parsing process, especially Subject , From , Date , Message-ID, References, and Delivered-To.Show all...

<= 100 items
name
string
required

Email header name.

<= 128 characters
value
string
required

Email header value.

<= 10240 characters
body
object

At least one out of HTML or text is required. HTML is recommended for a much better result.

html
string
required

The HTML content of an email.

>= 1 characters
text
string
required

The text content of an email.

>= 1 characters
attachments
array[Attachment] or null

Attachments of an email.Show all...

<= 30 items
labels
array[string]

Labels generated by email service providers such as Gmail

<= 50 items
country_region
string

ISO 3166 Alpha-3 code of the country or region. See ISO 3166 Country codes.

Auth
:
Body
preparing...