Changelog
v1.4.0 (2023-11-09)
Update | Endpoint |
---|---|
Improved the email parsing accuracy. | POST /email-parses POST /email-parses-v2 |
v1.3.0 (2023-10-19)
Update | Endpoint |
---|---|
Improved the email parsing accuracy. | POST /email-parses POST /email-parses-v2 |
v1.2.0 (2023-09-14)
Update | Endpoint | Before | After |
---|---|---|---|
A new field in store-v2 model slug , has been added to the email-parses-v2 API endpoints. This field is the unique identifier of a store. | POST /email-parses-v2 | - | - |
A new field in order-v2 model requires_shipping , has been added to the email-parses-v2 API endpoints. This field indicates whether the order requires shipping or not. | POST /email-parses-v2 | - | - |
Add definition of minimum valid parsing result. In our email-parses-v2 API, the definition of the minimum valid parsing result will be updated.See Minimum Valid Parsing Result. | POST /email-parses-v2 | V1 API minimum parsing result contains at least either one of the following fields: 1. order.order_number + order.store 2. order.trackings.tracking_number V2 API minimum parsing result contains at least either one of the following fields: 1. order.number + order.store 2. order.trackings.tracking_number | V1 API: Remains unchanged V2 API minimum parsing result will now contain at least either one of the following fields: 1. order.number 2. order.trackings.tracking_number |
v1.1.0 (2023-07-13)
Update | Endpoint |
---|---|
A new field, confidence_score , has been added to the email-parses API endpoints. This field indicates the probability of the request email containing order information according to the AfterShip Email Parser API system. The higher the value, the more likely the message includes order information. | POST /email-parses POST /email-parses-v2 |
v1.0.0 (2023-05-18)
We are pleased to release the AfterShip Parser V2 API, which can now accept email headers as input.
Update | Endpoint |
---|---|
New endpoint. | POST /email-parses-v2 |
Improved the parsing accuracy of field tracking_number . | POST /email-parses |
Improved the coverage of valid order or tracking emails. | POST /email-parses |
Improved the performance of AI engine. | POST /email-parses |
Breaking Change
These changes require special attention. If your app uses these API resources, and you don’t adjust your usage of the resources according to the following instructions, then your app might break when you update to V2 API version.
Email Parses
As of API V2, the following models have been deprecated from the Email Parsed API:
Order
: Use OrderV2 instead.OrderItem
: Use OrderItemV2 instead.Tracking
: Use TrackingV2 instead.Phone
: Use PhoneV2 instead.Address
: Use AddressV2 instead.Store
: Use StoreV2 instead.Money
: Use MoneyV2 instead.EstimatedDeliveryDate
: Use EstimatedDeliveryDateTime instead.ShippingMethod
: Use ShippingMethodV2 instead.DateTime
: Use DateTimeV2 instead.
v0.3.0(2023-05-06)
Update | Endpoint |
---|---|
Improved parsing of forwarded emails. | POST /email-parses |
v0.2.0 (2022-10-10)
Update | Endpoint |
---|---|
New field order_url in the Order object. To indicates the original page of the order, if there is an order URL inside the email. | POST /email-parses |
v0.1.0 (2022-04-24)
Update | Endpoint |
---|---|
First release. | POST /email-parses |