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

OrderV2

The order object contains at least 1 order number (order.number) or 1 tracking information (order.trackings.tracking_number). See Minimum Valid Parsing Result.

The order object contains at least 1 order number (order.number) or 1 tracking information (order.trackings.tracking_number). See Minimum Valid Parsing Result.

number
string or null
required

Order number.

Example:
23234324
url
string or null
required
Example:
https://www.amazon.com/gp/css/2323432.html
placed_at
DateTime or null
required
Example:
{"date":"2012-12-12","time":"13:06:22","utc_offset":8,"timezone_identifier":"Asia/Shanghai"}
date
string or null
required

Date string in YYYY-MM-DD format.

Example:
2012-12-12
time
string or null
required

Time string in HH:mm:ss format

Example:
13:06:22
utc_offset
number or null
required

UTC offset in hour.

Example:
8
timezone_identifier
string or null
required

Timezone identifier follows timezone database name.

Example:
Asia/Shanghai
status
string or null
required

Order status.

Allowed values:
openclosedcanceled
Example:
open
store
StoreV2 or null
required

Store object

[Store Slug](../../docs/other/store_slug.md)
Examples:
{"name":"example store","url":"https://www.example.ca","logo_url":"https://example.ca/logo.png","email":"[email protected]","phone":{"calling_code":"86","phone_number":"13010001000"},"slug":"example-ca"}{"name":"example store","url":"https://www.example.com","logo_url":"https://example.com/logo.png","email":"[email protected]","phone":{"calling_code":"86","phone_number":"13010001000"},"slug":"example"}
name
string or null
required

Store name.

Example:
example store
url
string or null
required

Store website URL

Example:
https://www.example-store.com
logo_url
string or null
required

The logo image url of the store.

Example:
https://example-store.com/logo.png
email
string or null
required

The contact email of the store.

Example:
[email protected]
phone
PhoneV2 or null
required

The phone number object.

Example:
{"calling_code":"86","phone_number":"13010001000"}
slug
string or null
required

Unique store code. The slug may be null when it cannot be identified from our store database, the other fields of stores (e.g. store.name) will be non-standardized values. See Store Slug .

items
array[OrderItemV2]
required

Items in this order.

external_product_id
string or null
required

The product id in the store.

Example:
3123213
title
string or null
required

The product title.

Example:
T-shirt
url
string<uri> or null
required

The product URL on the store’s website.

>= 1 characters
Example:
http://example.com/t-shirt.html
image_url
string<uri> or null
required

The image URL of the product.

>= 1 characters
Example:
http://example.com/images/t-shirt.png
quantity
number or null
required

The item quantity of the order.

Example:
2
unit_price
MoneyV2 or null
required

The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the currency will be null while the symbol will have a value.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
compare_unit_price
MoneyV2 or null
required

The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the currency will be null while the symbol will have a value.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
total_price
MoneyV2 or null
required

The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the currency will be null while the symbol will have a value.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
compare_total_price
MoneyV2 or null
required

The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the currency will be null while the symbol will have a value.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
variant_description
string or null
required

The variant description.

Example:
size: XL - color: red
status
string or null
required

Represents the item's display status.Show all...

shipping_address
AddressV2 or null
required
Example:
{"raw_location":"Shenzhen, China","phone":{"calling_code":"86","phone_number":"13010001000"}}
raw_location
string or null
required

Address raw location.

Example:
Shenzhen, China
phone
PhoneV2 or null
required

The phone number object.

Example:
{"calling_code":"86","phone_number":"13010001000"}
shipping_method
ShippingMethod or null
required

The shipping method.

name
string or null
required

The shipping method title.

Example:
Standard - free
billing_address
AddressV2 or null
required
Example:
{"raw_location":"Shenzhen, China","phone":{"calling_code":"86","phone_number":"13010001000"}}
total
Money or null
required

Order total amount.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
amount
string or null
required

The amount. It can be negative.

Example:
1.00
currency
string or null
required

The currency.

Example:
USD
raw_symbol
string or null
required

The original currency symbol extracted from the email.Show all...

Example:
$
subtotal
MoneyV2 or null
required

Order subtotal amount.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
amount
string or null
required

The amount. It can be negative.

Example:
1.00
currency
string or null
required

The currency.

Example:
USD
raw_symbol
string or null
required

The original currency symbol extracted from the email.Show all...

Example:
$
shipping_total
Money or null
required

Total shipping amount.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
amount
string or null
required

The amount. It can be negative.

Example:
1.00
currency
string or null
required

The currency.

Example:
USD
raw_symbol
string or null
required

The original currency symbol extracted from the email.Show all...

Example:
$
tax_total
Money or null
required

Total tax amount.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
amount
string or null
required

The amount. It can be negative.

Example:
1.00
currency
string or null
required

The currency.

Example:
USD
raw_symbol
string or null
required

The original currency symbol extracted from the email.Show all...

Example:
$
discount_total
Money or null
required

Total discount amount.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
amount
string or null
required

The amount. It can be negative.

Example:
1.00
currency
string or null
required

The currency.

Example:
USD
raw_symbol
string or null
required

The original currency symbol extracted from the email.Show all...

Example:
$
other_prices
array[object]
required

All other prices defined by the store (except order_total, subtotal, shipping_total, tax_total, discount_total).

title
string or null
required

Price description.

Example:
Reward Coupon
price
MoneyV2 or null

The money object is used to represent the currency amount. In some cases, if it cannot parse the currency from the symbol, the currency will be null while the symbol will have a value.

Example:
{"amount":"1.00","currency":"USD","raw_symbol":"$"}
trackings
array[TrackingV2]
required

Trackings parsed from the email.

status
string or null
required

Tracking status.

Allowed values:
DeliveredExceptionAttemptFailInTransitInfoReceivedOutForDeliveryExpiredPendingAvailableForPickup
Example:
Delivered
tracking_number
string or null
required

Tracking number.

Example:
234234
slug
string or null
required

Unique code of the courier.

Example:
ups
additional_fields
object or null

Additional information to identify the shipment and ensure its uniqueness.

items
array[OrderItemV2]
required

Items in the package.

tracking_url
string or null

The tracking_link is the link to the tracking page.

estimated_delivery_datetime
EstimatedDeliveryDateTime or null
required

It refers to the estimated delivery datetime parsed from the email. The maximum will be null if the estimated delivery datetime does not have a valid time range.

Examples:
{"min":{"date":"2012-12-12","time":"00:00:00","utc_offset":8,"timezone_identifier":"Asia/Shanghai"},"max":{"date":"2012-12-13","time":"00:00:00","utc_offset":8,"timezone_identifier":"Asia/Shanghai"}}{"min":{"date":"2012-12-13","time":null,"utc_offset":null,"timezone_identifier":null},"max":null}{"min":{"date":"2012-12-12","time":"00:00:00","utc_offset":null,"timezone_identifier":null},"max":{"date":"2012-12-13","time":"00:00:00","utc_offset":null,"timezone_identifier":null}}
min
DateTime or null
required

It refers to the starting value of the estimated delivery date.

Example:
{"date":"2012-12-12","time":"13:06:22","utc_offset":8,"timezone_identifier":"Asia/Shanghai"}
max
DateTime or null
required

It refers to the ending value of the estimated delivery date. It will be null if the estimated delivery date does not have a valid time range.

Example:
{"date":"2012-12-12","time":"13:06:22","utc_offset":8,"timezone_identifier":"Asia/Shanghai"}
requires_shipping
boolean or null
required

Whether the order requires shipping. If null, it means that AfterShip Parser is uncertain whether the order needs to be shipped and the user is required to make their own judgment.

Example
preparing...