Release 2.82.22
over 2 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Get Order | Add a new request field for order type. | 2022 Dec. 13th |
| Update Product Sorting in category | Deprecated this API | 2022 Dec. 13th |
| Get Order | Add agent_id field for social commerce manual order | 2022 Dec. 12th |
| Get Order | Add owner_type field in order_comments and order_notes | 2022 Dec. 12th |
| Cancel Order | Release this new API | 2022 Dec. 6th |
| Get Order | Add credit_reward_campaign_summary | 2022 Dec. 5th |
| Get Promotions | Support get promotions by promotion_ids | 2022 Dec. 5th |
| Update Product Sorting in category | Add more description for "category_id" | 2022 Nov. 29th |
| Get Webhook | Add "order_payment/update" | 2022 Nov. 10th |
| Get Order | Add more description to "created_by" and "created_from" | 2022 Nov. 9th |
| Create Order | Remove request parameter "created_from" description (because order created by Open API should use default value) | 2022 Nov. 9th |
| Get Customer Promotions | Release this API | 2022 Oct. 24th |
| Get Customer Promotions | Remove pagination support due to performance reason | 2022 Oct. 24th |
| Get Product | Adjust "includes" to "include_fields" and remove product_price_tier from include_fields | 2022 Oct. 4th |
| Update Order | Add description of deleting the data in "ref_order_id" field | 2022 Oct. 3rd |
| Update Product Price | Correct the description for price request parameter (can be 0, but can't be empty) 價格可以為 0 ，但不能為空值 | 2022 Oct. 3rd |
| Get Product | Add "retail_price" request parameter | 2022 Sep. 30th |
| Redeem Coupon | Release this new API | 2022 Sep. 26th |
| Send Coupon | Release this new API | 2022 Sep. 26th |
| Search Promotions | Release this new API | 2022 Sep. 26th |
| Get Merchants | Release this new API | 2022 Sep. 26th |
| Search Products | Support more request parameters (summary_translations, retail_status, with_product_set, purchasable and include_fields[]) | 2022 Sep. 26th |
| Get Order Setting | Add customer_cancel_order return field | 2022 Sep. 26th |
| Get Conversations Messages | Add time filters (start & end) | 2022 Sep. 26th |
| Delivery Time Slot | Release this new entity | 2022 Sep. 26th |
| Get Delivery Time Slots | Release this new API | 2022 Sep. 26th |
| Get Customer | Add include_fields[]=referrer_data ，可以拿到「此顧客註冊時的推薦人 SHOPLINE ID 以及名字」 | 2022 Sep. 26th |
| Split Order | Correct the wrong description (PATCH --> POST) and add description of "updated_at" | 2022 Sep. 8th |
| [Coming Soon] Cancel Order | Add new API page | 2022 Sep. 7th |
| [Coming Soon] Get Merchants | Add new API page | 2022 Sep. 5th |
| Order DeliveryAddress | Add "district" | 2022 Sep. 5th |
| Return Order | Add the description of "inspect_status" | 2022 Sep. 5th |
| Get Order | Add the description of "object_data.weight", payload example and Q&A | 2022 Aug. 29th |
| Get Product | Modify the data format from "Integer" to "Float" on weight | 2022 Aug. 29th |
| Create Return Order | Modify the description of "Country" and "Country Code" | 2022 Aug. 24th |
| Get Users Setting | Add line_login return field | 2022 Aug. 23rd |
| Get Channels | Remove pagination (max = 999 items) | 2022 Aug. 22nd |
| Order Payment | Add more description to "status". | 2022 Aug. 22nd |
| Order Delivery | Add more description to "status" and "delivery_status" | 2022 Aug. 22nd |
| Get Customer Membership Tier History | Change the API name from "Get Membership Tier Action Logs " to "Get Customer Membership Tier History" | 2022 Aug. 19th |
| Order Delivery | Add delivery platform examples | 2022 Aug. 19th |
| [Coming Soon] Get Delivery Time Slots | Add new API page | 2022 Aug. 18th |
| [Coming Soon] Delivery Time Slot | Add new entity | 2022 Aug. 18th |
| Order Payment | Add example of "信用卡分期訂單", "中租分期訂單" and "Atome訂單". | 2022 Aug. 17th |
| Get Webhook | Add member_point/create webhook payload example | 2022 Aug. 16th |
| Get Webhook | Add webhook topics on the document. - order/remove - order/pending - order/confirm - order/complete | 2022 Aug. 15th |
Release 2.82.21
over 2 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Delete Promotion | Release this new API | 2022 Aug. 14th |
| Get Order | Expose "cart_page_id" and "object_data.status" parameters | 2022 Aug. 14th |
| Create Order Message | Release this new API | 2022 Aug. 14th |
| Search Orders | Add statuses & delivery_statuses example | 2022 Aug. 14th |
| Split Order | Release this new API | 2022 Aug. 12th |
| Split Order | Add a new API page | 2022 Aug. 5th |
| Create Promotions | Add coupon_type field for draw coupon promotion | 2022 July 30th |
| Get Return Orders | Allow to get return orders by order_id / order_ids | 2022 July 30th |
| Member Point Summary | Add detail description | 2022 July 30th |
| Search Orders | Add request parameter "statuses", "delivery_statuses" (can search multiple status in one request) | 2022 July 30th |
| Delete Customer | Add request parameter "send_notification" | 2022 July 30th |
| Search Promotions | Add a new API page | 2022 July 29th |
| Send Coupon | Add a new API page | 2022 July 29th |
| Redeem Coupon | Add a new API page | 2022 July 29th |
| Get Promotions | Remove request parameter "customer_id" & "scope" (will support in new API) | 2022 July 21st |
| API Reference | Publish "API Reference" Section | 2022 July 21st |
| Add or Remove Customer tags | Release this new API | 2022 July 16th |
| Order Promotion_items | Add applied "coupon_code" in the order data | 2022 July 15th |
| Auto Reward Credit Summary | Update description | 2022 July 15th |
| Create Promotions | Update docs for partial free shipping | 2022 July 15th |
| Get Promotion | Support partial free shipping promotion | 2022 July 15th |
| Get Order | Add "member_point_summary" and "auto_reward_credit_summary" parameters | 2022 July 15th |
| Get Channels | Release this new API | 2022 July 15th |
| Get Promotion | Modify the description of "usable" parameter | 2022 July 11th |
| Member Point Summary | Add new entity page | 2022 July 5th |
| Auto Reward Credit Summary | Add new entity page | 2022 July 5th |
| Get Product Review Comments | Add "Note" to provide more description on default sorting | 2022 July 2nd |
Release 2.82.20
over 2 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Get Membership Tier Action Logs | Release "Get Membership Tier Action Logs" API | 2022 July 2nd |
| Create Promotions | Support discountable_product_ids in benefit_tiers field | 2022 July 2nd |
| Search Orders | Add delivery_option_type for order search | 2022 July 2nd |
| [Coming Soon] Get Membership Tier Action Logs | Add new API page | 2022 June 29th |
| [Coming Soon] Get Channels | Add new API page | 2022 June 29th |
| Get Membership Tiers Money | Add more description on cents "Price 欄位 Cents 的最大值為 99999999900" | 2022 June 29th |
| Delete Customer | Modify the API title from "Delete Customers" to "Delete Customer" because this API only allows delete 1 customer per time. | 2022 June 28th |
| Create Product Review Comment Bulk Create Product Review Comments | Release these 2 new API. | 2022 June 25th |
| Add or Remove Customer tags | Change document to [Coming Soon] because need to develop permission UI. | 2022 June 24th |
| Get Webhook | Add new example payload: comment/payment_slip_upload | 2022 June 22nd |
| Get Promotion | Edit Response Example | 2022 June 22nd |
| Update Customer | Add is_accept_marketing | 2022 June 22nd |
| Add Product Variation | Add selector_enabled description to variant_options | 2022 June 22nd |
| Create Product | Add selector_enabled description to variant_options | 2022 June 22nd |
| Update Product | Add selector_enabled and update default_show_image_selector description | 2022 June 22nd |
| Update Promotions | Mark some inactive parameters in Request Example | 2022 June 22nd |
| Get Webhook | Add new example payload: order/status_notify_customer order_payment/status_notify_customer order_delivery/status_notify_customer order/product_detail_notify_customer | 2022 June 22nd |
Release 2.82.19
almost 3 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Get Webhook Create Webhook Update Webhook | Add 5 new webhook topic: - order/status_notify_customer - order/product_detail_notify_customer - order_payment/status_notify_customer - order_delivery/status_notify_customer - comment/payment_slip_upload [Coming Soon] | 2022 June 8th |
| Create Customer | Modify "name" from required field to optional. | 2022 June 8th |
| Update Customer Store Credits | Add request parameter example for Never Expire store credit | 2022 June 8th |
| Create Promotions | Mark some inactive parameters | 2022 June 8th |
| Order related webhook | 從 2022 June 8th 開始，透過 Open API 去更新訂單狀態，都會觸發對應 webhook. （之前不會觸發) | 2022 June 8th |
| Update Product Sorting in category | Add 「priority 數字越小，在 PLP(商品分類頁)會顯示在越後面；priority 數字越大則顯示在越前面。」description | 2022 June 8th |
| Get Promotions | Add filter parameters for getting user promotions | 2022 May 30th |
| Get Membership Tiers | Update membership tier response example (fix "item" structure) | 2022 May 30th |
| Get Users Setting | Add request and response parameters for user_credit_rules & member_point_rules | 2022 May 30th |
| Search Products | Add query strings for search products | 2022 May 26th |
| Get Products | Add example of excludes[ ] | 2022 May 26th |
| Get Delivery Options | Add Get Delivery Options of store_pickup_options | 2022 May 20th |
| Create Product | Remove unsupported parameters "is_excluded_promotion" and "taxable" | 2022 May 19th |
| Get Membership Tiers | Add member_point_rules and user_credit_rules | 2022 May 19th |
Release 2.82.18
almost 3 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Get Webhook Create Webhook | Add new webhook: invoice/update and payload example | 2022 Apr. 29th |
| Get Order | Add Q&A section for some frequently asked questions | 2022 Apr. 29th |
| [ComingSoon]Get Customer Promotions | Add new API page | 2022 Apr. 29th |
| Execute Shipment | Add more description about error code | 2022 Apr. 29th |
| Create Product Review Comment Bulk Create Product Review Comments | Revert these 2 API page to [Coming Soon] because permission UI issue. | 2022 Apr. 29th |
| Get Staff Permission | Add instruction of finding the permission field name through Admin page | 2022 Apr. 29th |
| [Coming Soon] Member Point Rule | Add new API page | 2022 Apr. 26th |
| Get Product Review Comment Get Product Review Comments | Remove unnecessary notice message | 2022 Apr. 26th |
| Execute Shipment | Add HCT | 2022 Apr. 22nd |
| Order Delivery | Add description of platform | 2022 Apr. 22nd |
| Get Delivery Option | Add description of region_type | 2022 Apr. 22nd |
| Get Delivery Options | Add JSON example (tw_fm_c2c_pay) | 2022 Apr. 22nd |
| Get Products | Add Product Set Example | 2022 Apr. 22nd |
| Order Subtotal_items | Add Product Set related response fields. | 2022 Apr. 22nd |
| How to get access_token | Add "如果是通過 Developer Center 對接的擴充功能，不需要申請使用 OpenAPI" instruction. | 2022 Apr. 19th |
| Get Order Labels for Delivery | Add fmt_freeze, cross_border_711_store_pick_up and cross_border_711_home_delivery to Response Fields | 2022 Apr. 19th |
| Get Order | Add "channel that created the order" | 2022 Apr. 19th |
| Create Webhook | Add -user/membership_tier_update webhook | 2022 Apr. 19th |
| [Coming Soon] User Credit Rule | Add new API page | 2022 Apr. 19th |
| Get Products | Add the request fields of listing Product Set | 2022 Apr. 17th |
| Get Customer | Expose offline referral data in customer data (for Smart OMO only) | 2022 Apr. 14th |
| Get Order | Delete 2 fields which doesn't exist in the response ("applied_member_point" & "applied_member_point_redeem_to_cash") | 2022 Apr. 14th |
| Execute Shipment | Support 2 more delivery services: 7-11 Cross Border and FMT Freeze | 2022 Apr. 8th |
| Bulk Execute Shipment | Formal released to support 7-11 Cross Border and FMT Freeze | 2022 Apr. 8th |
| OpenAPI request example | Add sample response of IP banned situation | 2022 Apr. 6th |
| 1. [Coming Soon] Get Conversations 2. [Coming Soon] Get Conversations Messages | Add 2 new API page | 2022 Apr. 6th |
Release 2.82.17
almost 3 years ago by Iris
| Affected API or Entity | Description | Release date |
|---|---|---|
| Get Customer | Add membership_tier_gap entity | 2022 Mar. 30th |
| [Coming Soon] Bulk Execute Shipment | Add detail description | 2022 Mar. 30th |
| Update Order Status | Update valid enum of order status | 2022 Mar. 30th |
| Get Order Transactions | Add "note" field and the description of Request Response | 2022 Mar. 30th |
| Update Product | Remove 'removed' status and add description of status parameters. | 2022 Mar. 30th |
| Get Customer | Add the description of line ID parameter | 2022 Mar. 30th |
| [Coming Soon] Get Staff Permission | Add a new API page | 2022 Mar. 29th |
| Get Order | Add JSON example with Product Set items | 2022 Mar. 22nd |
| Update Order Invoice | Make this API [Coming Soon] due to some permission issue | 2022 Mar. 21st |
| Get Order Transactions | Update order ID array example | 2022 Mar. 21st |
| (All webhook related pages) | Add "Order Status Webhook Enhancement" announcement | 2022 Mar. 15th |
| [Coming Soon] Bulk Execute Shipment | Add Bulk Execute Shipment new API page (Coming Soon) | 2022 Mar. 15th |
| Get Return Orders | Add 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 id | Correct the description of request parameter (Return Order ID) | 2022 Mar. 11th |
| Pagination | Add pagination instruction | 2022 Mar. 10th |
| Store Credit History | Add more description of response parameters | 2022 Mar. 10th |
| Get Customer Store Credit History | Add 1 more JSON example | 2022 Mar. 10th |
| Update Order | Revise format for config data format to an array | 2022 Mar. 4th |
| Get Customer | Fix incorrect description on next_total_spending parameter | 2022 Mar. 4th |
| Get Delivery Option | Modify the fields of config_data. For example: config_data.lead_time | 2022 Mar. 2nd |
Release 2.82.16
about 3 years ago by Draco
| Affected API or Entity | Description | Release date |
|---|---|---|
| Create Media | Add failure cases for media Update new response body for creating media | 2022 Feb. 25th |
| Get Agents | Remove unnecessary fields (strategy) and modify response example Add pagination | 2022 Feb. 23rd |
| Create Category | Add priority parameters | 2022 Feb. 23rd |
| Create Media | Add examples to upload media | 2022 Feb. 23rd |
| Get Member Point Rules | Add more descriptions to the field available_platforms | 2022 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 Transactions | Add Get Order Transactions new API page (Coming soon) Add Request and Response Sample | 2022 Feb. 22nd (2022 Feb. 24th formal released) |
| Get Member Point Rules | Add pagination params Delete impossible status - removed | 2022 Feb. 21st |
| Get Tax Setting | Add Get Tax Setting new API page (Coming soon) | 2022 Feb. 21st |
| Order Subtotal_items | Update response param 'object_data' | 2022 Feb. 21st |
| Get Users Setting | Add response data and parameter description | 2022 Feb. 21st |
| Get Delivery Option | Add response parameters and response example | 2022 Feb. 21st |
| Search Products | Update description and example of request param 'sku' Add request param 'barcode' | 2022 Feb. 21st |
| Update Product Variation | Add request params 'gtin' Update response example | 2022 Feb. 21st |
| Add Product Variation | Add request params 'gtin' Update response example | 2022 Feb. 21st |
| Order DeliveryAddress | Update Order DeliveryAddress field 'logistic_codes' description and example | 2022 Feb. 21st |
| Get Agents | Add Get Taxes new API page (Coming soon) Add Agents Entity page (Coming soon) | 2022 Feb. 18th |
| Get Taxes | Add Get Taxes new API page (Coming soon) | 2022 Feb. 18th |
| Get Delivery Option | Add response parameters for config data and add example | 2022 Feb. 18th |
| Update Order | Add request param 'custom_data' | 2022 Feb. 16th |
| Get Order Setting | Add response parameters Refine response example | 2022 Feb. 16th |
| Update Product | Add description when updating product with images | 2022 Feb. 16th |
| Create Product | Add description for creating product with images | 2022 Feb. 16th |
| Get Categories | Add request param 'created_by_filter' Refine response example | 2022 Feb. 16th |
| Get Customer Member points History | Add response param "created_at" | 2022 Feb. 16th |
| Get Order Create Order | added field "created_from" to indicate the original source of the order | 2022 Feb. 16th |
| Get Token Info | added field "user" | 2022 Feb. 16th |
| Bulk Assign Product to Category | updated response example | 2022 Feb. 16th |
| Get Order Label | updated "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 Rules | added Get Member Point Rules added Get Users Settings | 2022 Feb. 16th |
| Get Membership Tiers | updated response table and response example | 2022 Feb. 16th |
| Update Promotion | update 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 Settings | added Get Checkout Settings | 2022 Feb. 16th |
| Update Order Invoice | added Update Order Invoice | 2022 Feb. 16th |
Release 2.82.15
about 3 years ago by Draco
| Affected API | Description | Release date |
|---|---|---|
| Get Customer | added request parameters "fields[]= membership_tier_gap" added response parameters "next_total_spending" | 2022 Feb. 11th |
| Get Membership Tiers | Update the fields exposed in the Get Membership Tiers | 2022 Feb. 16th |
| Improvement: Get Product / Get Products | added description | |
| Get Customer member points history | Getting customer member point history | |
| Get shipping label | updated to add hct and tcat | |
| Get Product Subscription / Get Product Subscription | added initial_billing_at, created_at, updated_at to response example | |
| Create Customer / Update Customer | updated 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 Gifts | added unlimited_quantity to response example | |
| Get Product | added an example of variations and variant_options to the response example | |
| Create Product / Update Product | updated description of variant_options and variant_custom_type_translations | |
| Add Product Variation | updated description of variant_options |
Release 2.82.14
about 3 years ago by Draco
| Affected API | Description |
|---|---|
| Get Customer | added confirmed at field Added timezone hint for datetime fields |
| Search Customer | added id[] search field |
| Create Product Update Product Create Product Variation | added default_show_image_selector |
| Create Media | Added maximum file size description |
| Order Delivery | Added updated_at field |
| Update Merchant | Added update merchant endpoint |
Release 2.82.13
about 3 years ago by Draco
| Affected API | Description |
|---|---|
| Update Product Sorting in category | Add 500 as max number of products during update |
| Promotion Object | Added title_translation |