HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Changelog

Release 2.82.17

Affected API or EntityDescriptionRelease date
Get CustomerAdd membership_tier_gap entity2022 Mar. 30th
[Coming Soon] Bulk Execute ShipmentAdd detail description2022 Mar. 30th
Update Order StatusUpdate valid enum of order status2022 Mar. 30th
Get Order TransactionsAdd "note" field and the description of Request Response2022 Mar. 30th
Update ProductRemove 'removed' status and add description of status parameters.2022 Mar. 30th
Get CustomerAdd the description of line ID parameter2022 Mar. 30th
[Coming Soon] Get Staff PermissionAdd a new API page2022 Mar. 29th
Get OrderAdd JSON example with Product Set items2022 Mar. 22nd
Update Order InvoiceMake this API [Coming Soon] due to some permission issue2022 Mar. 21st
Get Order TransactionsUpdate order ID array example2022 Mar. 21st
(All webhook related pages)Add "Order Status Webhook Enhancement" announcement2022 Mar. 15th
[Coming Soon] Bulk Execute ShipmentAdd Bulk Execute Shipment new API page (Coming Soon)2022 Mar. 15th
Get Return OrdersAdd the instruction of getting items in the return order and made the request sample to the top of this page.2022 Mar. 11th
Get Return Order By idCorrect the description of request parameter (Return Order ID)2022 Mar. 11th
PaginationAdd pagination instruction2022 Mar. 10th
Store Credit HistoryAdd more description of response parameters2022 Mar. 10th
Get Customer Store Credit HistoryAdd 1 more JSON example2022 Mar. 10th
Update OrderRevise format for config data format to an array2022 Mar. 4th
Get CustomerFix incorrect description on next_total_spending parameter2022 Mar. 4th
Get Delivery OptionModify the fields of config_data.
For example: config_data.lead_time
2022 Mar. 2nd

Release 2.82.16

Affected API or EntityDescriptionRelease date
Create MediaAdd failure cases for media
Update new response body for creating media
2022 Feb. 25th
Get AgentsRemove unnecessary fields (strategy) and modify response example
Add pagination
2022 Feb. 23rd
Create CategoryAdd priority parameters2022 Feb. 23rd
Create MediaAdd examples to upload media2022 Feb. 23rd
Get Member Point RulesAdd more descriptions to the field available_platforms2022 Feb. 23rd
- Create Product
- Get Products
- Get Product
- Search Products
- Update Product
- Add Product Variation
- Update Product Variation
- Delete Product Variation
- Add Product Images
Add more response data (out_of_stock_orderable, subscription_enabled , subscription_period_duration, filter_tags)2022 Feb. 23rd
Get Order TransactionsAdd Get Order Transactions new API page (Coming soon)
Add Request and Response Sample
2022 Feb. 22nd
(2022 Feb. 24th formal released)
Get Member Point RulesAdd pagination params
Delete impossible status - removed
2022 Feb. 21st
Get Tax SettingAdd Get Tax Setting new API page (Coming soon)2022 Feb. 21st
Order Subtotal_itemsUpdate response param 'object_data'2022 Feb. 21st
Get Users SettingAdd response data and parameter description2022 Feb. 21st
Get Delivery OptionAdd response parameters and response example2022 Feb. 21st
Search ProductsUpdate description and example of request param 'sku'
Add request param 'barcode'
2022 Feb. 21st
Update Product VariationAdd request params 'gtin'
Update response example
2022 Feb. 21st
Add Product VariationAdd request params 'gtin'
Update response example
2022 Feb. 21st
Order DeliveryAddressUpdate Order DeliveryAddress field 'logistic_codes' description and example2022 Feb. 21st
Get AgentsAdd Get Taxes new API page (Coming soon)
Add Agents Entity page (Coming soon)
2022 Feb. 18th
Get TaxesAdd Get Taxes new API page (Coming soon)2022 Feb. 18th
Get Delivery OptionAdd response parameters for config data and add example2022 Feb. 18th
Update OrderAdd request param 'custom_data'2022 Feb. 16th
Get Order SettingAdd response parameters
Refine response example
2022 Feb. 16th
Update ProductAdd description when updating product with images2022 Feb. 16th
Create ProductAdd description for creating product with images2022 Feb. 16th
Get CategoriesAdd request param 'created_by_filter'
Refine response example
2022 Feb. 16th
Get Customer Member points HistoryAdd response param "created_at"2022 Feb. 16th
Get Order
Create Order
added field "created_from" to indicate the original source of the order2022 Feb. 16th
Get Token Infoadded field "user"2022 Feb. 16th
Bulk Assign Product to Categoryupdated response example2022 Feb. 16th
Get Order Labelupdated "Danger" note block
updated "function" description
added "Response Fields > failed_orders" description and example
updated "Response Example"
updated "Occasions when labels cannot be printed" section description and example
2022 Feb. 16th
Get Member Point Rulesadded Get Member Point Rules
added Get Users Settings
2022 Feb. 16th
Get Membership Tiersupdated response table and response example2022 Feb. 16th
Update Promotionupdate request params for every discount_type
added descriptions for updating seo_title_translations, seo_description_translations, seo_keywords and term_translations
2022 Feb. 16th
Checkout Settingsadded Get Checkout Settings2022 Feb. 16th
Update Order Invoiceadded Update Order Invoice2022 Feb. 16th

Release 2.82.15

Affected APIDescriptionRelease date
Get Customeradded request parameters "fields[]= membership_tier_gap"
added response parameters "next_total_spending"
2022 Feb. 11th
Get Membership TiersUpdate the fields exposed in the Get Membership Tiers2022 Feb. 16th
Improvement: Get Product / Get Productsadded description
Get Customer member points historyGetting customer member point history
Get shipping labelupdated to add hct and tcat
Get Product Subscription / Get Product Subscriptionadded initial_billing_at, created_at, updated_at to response example
Create Customer / Update Customerupdated type and description of phones
added mobile_phone, mobile_phone_country_calling_code to the request parameters and request example
added phone, mobile_phone, mobile_phone_country_calling_code to response example
Get Gifts / Search Giftsadded unlimited_quantity to response example
Get Productadded an example of variations and variant_options to the response example
Create Product / Update Productupdated description of variant_options and variant_custom_type_translations
Add Product Variationupdated description of variant_options

Release 2.82.14

Affected APIDescription
Get Customeradded confirmed at field
Added timezone hint for datetime fields
Search Customeradded id[] search field
Create Product
Update Product
Create Product Variation
added default_show_image_selector
Create MediaAdded maximum file size description
Order DeliveryAdded updated_at field
Update MerchantAdded update merchant endpoint

Release 2.82.13

Affected APIDescription
Update Product Sorting in categoryAdd 500 as max number of products during update
Promotion ObjectAdded title_translation

Release 2.82.12

Affected APIDescription
Webhook createadded product/create, product/update, product/remove webhook for subscription

Release 2.82.11

Affected APIDescription
Flash price Campaign APIGet, PUT, POST and Delete Flash Price Campaign API

Release 2.82.10

Affected APIDescription
Update customer tagsAllow passing an array to update all replace existing customer tags with an array of new customer tags
Add or remove customer tagsAllow specify to add / remove specific customer tags of a customer without knowing the existing tags

Release 2.82.9

Affected APIDescription
Create and Update PromotionProvide example for all promotion and support type

Release 2.82.8

Affected APIDescription
Get Order label APIInclude tCat and SF Express label