Release 2.235.1
10 months ago by Iris
Affected API or Entity | Description | Release Date |
---|---|---|
Search Products | sort_type support custom_sorting (自訂排序) | 2024 Jan. 30th |
Create Order | Add FAQ - 歷史訂單匯入 | 2024 Jan. 30th |
Get Order | Add FAQ - 訂單是否可以抓取各商品折扣分攤的金額? | 2024 Jan. 30th |
Release 2.233.0
about 1 year ago by Iris
Affected API or Entity | Description | Release Date |
---|---|---|
Webhook Implementation Best Practices | New page to describe Webhook Implementation Best Practices | 2024 Jan. 9th |
How to get access_token | Can set IP Whitelist for Open API token (by staff email) | 2024 Jan. 10th |
Release 2.222.0
over 1 year ago by Iris
Affected API or Entity | Description | Release Date |
---|---|---|
Update Product Variation Price | Support more request parameters | 2023 Sep 7th |
Generate Express Cart Link | Release a new API | 2023 Oct 23rd |
Release 2.219.0
over 1 year ago by Iris
Affected API or Entity | Description | Release Date |
---|---|---|
Cancel Order | Add request parameter refund_order and mail_notify | 2023 Sep 7th |
- Add Live Products - Update Product and Variation Keywords - Get Livestream Products and Variations | Release these 3 new API | 2023 Aug 15th |
Webhook Topic and Payload Example | Update user/membership_tier_update webhook description | 2023 Aug 9th |
Cancel Order | Add more description to revert_credits and revert_member_points | 2023 Aug 9th |
Get Delivery Option | Add more description to store_pickup_option (門市自取) | 2023 Aug 9th |
Get Promotions | Update the description of per_page (max = 100) | 2023 Aug 2nd |
Order Invoice | Update the description of invoice_tax_type | 2023 Aug. 1st |
Release 2.212.0
over 1 year ago by Iris
Affected API or Entity | Description | Release date |
---|---|---|
Update Product Variation | Add more description for params.quantity range | 2023 July 20th |
Update Product Variation Quantity | Add more description for params.quantity range | 2023 July 20th |
Get Product | Add more description for product "lowest_price" and "lowest_price_sale" | 2023 July 20th |
Update Product Sorting in category | Hide the document for deprecated API (OA-2112) | 2023 July 16th |
Create Webhook | Add "Webhook 訂閱規範" | 2023 July 5th |
Order Subtotal_items | Add more description for product set related fields | 2023 July 12th |
Execute Shipment | 單筆出貨支援黑貓快速到店 | 2023 July 12th |
Get Order Labels for Delivery | 支援黑貓快速到店(常溫、冷藏、冷凍)大量列印標籤 | 2023 July 12th |
Release 2.82.24
over 1 year ago by Iris
Affected API or Entity | Description | Release date |
---|---|---|
Get Order Setting | Add default_out_of_stock_reminder in response parameter (To be released OA-2074) | 2023 June 16th |
Create Return Order | delivery_option.key is required. | 2023 June 16th |
Get Products | Add more description for per_page | 2023 June 16th |
Get Action Logs | Add more description "at most 100 logs" for this API | 2023 June 16th |
Order DeliveryAddress | Remove deprecated parameters layer1 , layer2 , layer3 from the document | 2023 June 16th |
Get Product Review Comments | Add status in request parameters | 2023 June 16th |
- Update Customer - Create Customer | Add description for recipient_phone_country_code | 2023 June 16th |
Update Order Status | Add more description on cancelled status | 2023 June 8th |
Create Affiliate Campaign | Add more description on condition_min_amount | 2023 June 6th |
- Update Order Invoice - Get Staff - Get Staff List | Remove [Coming Soon] | 2023 June 1st |
Webhook Topic and Payload Example | Add trigger point description to order/update | 2023 June 1st |
Get Order | Add more description for type | 2023 May 30th |
Update Customer | Correct the type description of tags on the Doc (from String to Array) | 2023 May 26th |
Order CustomerInfo | Add more description of birthday | 2023 May 25th |
Translation | Complete the description of supported languages | 2023 May 23rd |
Get Orders | Add order_ids in request parameters | 2023 May 22nd |
- Create Product - Update Product - Create AddonProducts - Update AddonProducts | Add tax_type and oversea_tax_type in request parameter | 2023 May 22nd |
- Get Products - Get Product - Search Products - Get AddonProducts - Search Addon Products | Add tax_type and oversea_tax_type in response example | 2023 May 22nd |
Update Customer Store Credits | Add the limitation of expires_at | 2023 May 22nd |
Order Subtotal_items | Explain more precisely of item_data | 2023 May 19th |
Create AddonProducts | Add product_id to assign an existing product to sell as add on item | 2023 May 19th |
Create Gifts | Add product_id to assign an existing product to sell as a gift item | 2023 May 19th |
Get Users Setting | Add email_verification , email_login_with_verification and sms_verification in response | 2023 May 19th |
Update Product | Correct blacklisted_payment_ids typo | 2023 May 18th |
Get Customer | Return email/mobile_phone verification status with unconfirmed_email | 2023 May 18th |
Get Order | Add preorder_note_translations | 2023 May 18th |
Order Subtotal_items | Add preorder_note_translations | 2023 May 18th |
Order Delivery | Correct the Chinese description of platform value | 2023 May 17th |
Update Customer | Add phone and phone_country_code to substitute phones | 2023 May 9th |
Webhook Topic and Payload Example | Add customer_group/update webhook detail | 2023 May 9th |
Webhook Topic and Payload Example | Release this new page to show all webhook topic and payload example | 2023 May 8th |
Get Checkout Setting | Add muti-checkout fields in response parameter | 2023 May 5th |
Search Products | Add support fields scope in query parameter (title_translations & summary_translations) | 2023 May 5th |
Update Product | Remove unsupported request parameter "is_excluded_promotion" & "taxable" | 2023 May 5th |
Create Shop Message | Release this new API | 2023 May 4th |
- Get Product - Get Products - Search Products | Add "preorder_limit" in response parameter (will release on 2023 May 24th) | 2023 Apr. 27th |
- Create Product - Update Product - Add Product Variation - Update Product Variation | Add "preorder_limit" in request parameter (will release on 2023 May 24th) | 2023 Apr. 26th |
Get Webhook | Add "pos_return_order/create" and "pos_return_order/update" webhook topics | 2023 Apr. 21st |
Get Conversations | Add "customer_id" in request parameter | 2023 Apr. 19th |
- Get Purchase Order - Get Purchase Orders - Create Purchase Order - Delete Purchase Orders | Release 4 new API for Purchase Order (進貨單) | 2023 Apr. 19th |
Get Users Setting | Add "birthday_format" in response parameter (will release on 2023 May 24th) | 2023 Apr. 19th |
Create Customer | Add "birth_year", "birth_month", "birth_day" in request parameter (will release on 2023 May 24th) | 2023 Apr. 19th |
Update Customer | Add "birth_year", "birth_month", "birth_day" in request parameter (will release on 2023 May 24th) | 2023 Apr. 19th |
Search Customers | Add "birth_month" in request parameter (will release on 2023 May 24th) | 2023 Apr. 19th |
Get Customer | Add "birth_year", "birth_month", "birth_day" in response parameter (will release on 2023 May 24th) | 2023 Apr. 19th |
Get Customer | Add "subscription" in request parameter to show if customer subscribes to SMS | 2023 Apr. 18th |
Create Return Order | Add "city" in request parameter | 2023 Apr. 16th |
[Coming Soon] Get Purchase Order | Add a new API | 2023 Apr. 16th |
[Coming Soon] Delete Purchase Orders | Add a new API | 2023 Apr. 16th |
[Coming Soon] Create Purchase Order | Add a new API | 2023 Apr. 16th |
[Coming Soon] Get Purchase Orders | Add a new API | 2023 Apr. 16th |
[Coming Soon] Create Shop Message | Add a new API | 2023 Apr. 16th |
Get Customer Member points History | Add "order_number" to response parameters | 2023 Apr. 16th |
Search Promotions | Support more discount type, such as "subscription_percentage", "subscription_amount", "credit_reward" | 2023 Apr. 16th |
Order Payment | Modify the payment type example format | 2023 Apr. 16th |
Create Return Order | Add "return_reason_key", "return_remark", "quantity" for request parameters | 2023 Apr. 14th |
Get Delivery Option | Add "is_return" to present the delivery option is for returning | 2023 Apr. 14th |
Search Products | Add "sort_type" to product search | 2023 Apr. 14th |
Get Channels | Add "platforms" as new request params and update description | 2023 Apr. 14th |
Get Customer IDs of User Coupon | Release this new API | 2023 Apr. 13th |
Get Order | Add product_subscription_period field | 2023 Apr. 13th |
Get Order | Add checkout object related data. (多購物車) | 2023 Apr. 12th |
Get Customer Membership Tier History | Add description of items[].key and example of new version data | 2023 Apr. 10th |
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
over 2 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 |