QUICKSTART

CHANGELOG

Changelog

OTHER

Store Slug

Minimum Valid Parsing Result

Reference

Email Parses

Model

Envelope

Order

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

order_number

string or null

required

Order number.

Example:

23234324

order_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:

timezone_identifier

string or null

required

Timezone identifier follows timezone database name.

Example:

Asia/Shanghai

order_status

string or null

required

Order status.

Allowed values:

openclosedcanceled

Example:

open

store

Store or null

required

Store object

Example:

{"name":"example store","url":"https://www.example-store.com","logo_url":"https://example-store.com/logo.png","email":"[email protected]","phone":{"country_region_code":"86","number":"13010001000"}}

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

string or null

required

The contact email of the store.

Example:

[email protected]

phone

Phone or null

required

The phone number object.

Example:

{"country_region_code":"86","number":"13010001000"}

items

array[OrderItem]

required

Items in this order.

external_product_id

string or null

required

The product id in the store.

Example:

3123213

product_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:

unit_price

Money 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","symbol":"$"}

compare_unit_price

Money 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","symbol":"$"}

total_price

Money 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","symbol":"$"}

compare_total_price

Money 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","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

Address or null

required

Example:

{"raw_location":"Shenzhen, China","phone":{"country_region_code":"86","number":"13010001000"}}

raw_location

string or null

required

Address raw location.

Example:

Shenzhen, China

phone

Phone or null

required

The phone number object.

Example:

{"country_region_code":"86","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

Address or null

required

Example:

{"raw_location":"Shenzhen, China","phone":{"country_region_code":"86","number":"13010001000"}}

order_total

Money or null

required

Order total amount.

Example:

{"amount":"1.00","currency":"USD","symbol":"$"}

amount

string or null

required

The amount. It can be negative.

Example:

1.00

currency

string or null

required

The currency.

Example:

USD

symbol

string or null

required

The symbol of currency.

Example:

subtotal

Money or null

required

Order subtotal amount.

Example:

{"amount":"1.00","currency":"USD","symbol":"$"}

amount

string or null

required

The amount. It can be negative.

Example:

1.00

currency

string or null

required

The currency.

Example:

USD

symbol

string or null

required

The symbol of currency.

Example:

shipping_total

Money or null

required

Total shipping amount.

Example:

{"amount":"1.00","currency":"USD","symbol":"$"}

amount

string or null

required

The amount. It can be negative.

Example:

1.00

currency

string or null

required

The currency.

Example:

USD

symbol

string or null

required

The symbol of currency.

Example:

tax_total

Money or null

required

Total tax amount.

Example:

{"amount":"1.00","currency":"USD","symbol":"$"}

amount

string or null

required

The amount. It can be negative.

Example:

1.00

currency

string or null

required

The currency.

Example:

USD

symbol

string or null

required

The symbol of currency.

Example:

discount_total

Money or null

required

Total discount amount.

Example:

{"amount":"1.00","currency":"USD","symbol":"$"}

amount

string or null

required

The amount. It can be negative.

Example:

1.00

currency

string or null

required

The currency.

Example:

USD

symbol

string or null

required

The symbol of currency.

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

Money 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","symbol":"$"}

trackings

array[Tracking]

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[OrderItem]

required

Items in the package.

tracking_url

string or null

The tracking_link is the link to the tracking page.

estimated_delivery_date

EstimatedDeliveryDate or null

required

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

Examples:

{"estimated_delivery_date_min":"2021-12-11","estimated_delivery_date_max":"2021-12-12"}{"estimated_delivery_date_min":"2021-12-11","estimated_delivery_date_max":null}

estimated_delivery_date_min

string<date> or null

required

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

Example:

2021-12-11

estimated_delivery_date_max

string<date> 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:

2021-12-12

Example

preparing...