Tracking

Tracking information parsed from the email

Tracking information 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.

postal_code
string

The postal code of the tracking.

Example:
xxxxxx
ship_date
string

The shipping date of the tracking is in YYYY-MM-DD format.

Example:
2018-11-11
state
string

The state of the tracking.

Example:
xxx
origin_country
string

The origin country of the tracking.

Example:
CHN
destination_country
string

The destination country of the tracking.

Example:
CHN
items
array[OrderItem]
required

Items in the package.

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:
2
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...

tracking_url
string or null

The tracking_link is the link to the tracking page.

Example
preparing...