Release 2.82.24

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/updatewebhook 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