What's new with SHOPLINE APIs?​

November 2025​

Discount & Marketing Management​

• Discount Item Field Updates: In the Admin GraphQL API, the fields, collections, productVariants, and products, in the objects listed below previously returned null when there was no data. Starting December 10, 2025, these fields will return an empty array [] instead. Affected objects include:
  • DiscountCodeBasic
  • DiscountCodeBxgy
  • DiscountAutomaticBasic
  • DiscountAutomaticBxgy
  • DiscountAutomaticPfnt
  • DiscountAutomaticDoni
  • DiscountAutomaticDoli

Order Management​

• Return Order Status Updates: Starting December 15, 2025, a new return order status cancelled will be added. This allows you to cancel a return order. After a return order is canceled, the items in that order can be submitted for return again.

SHOPLINE Payments​

• Webhook Update: Two new events, Dispute created and Dispute updated, have been added to help you get dispute-related information more quickly.

August 2025​

Order Management​

• Order Attribution Query: You can now use the Admin REST API Get order attribution to bulk query order attribution details. This helps you quickly understand where each order comes from.

SHOPLINE Payments​

• Store Payout Records Query: To enhance performance and user experience, please upgrade to API version v20250601 or later when using the Get payout records. Older versions will be deprecated and no longer supported.

July 2025​

Order Management​

• Order & Draft Order Field Updates: A new field standard_province_code has been added to the shipping and billing address sections of the following Admin REST APIs and Webhooks. This field follows the ISO 3166-2 standard.
  • Order-related APIs
    • Get orders
    • Update an order
    • Cancel order
    • Get abandoned checkouts
  • Draft Order-related APIs
    • Create a draft order
    • Edit draft order
    • Query draft order
    • Complete draft order
  • Order-related Webhooks
    • Order paid successfully
    • Order updated
    • Order cancelled
    • Order all shipped
    • Order partially shipped
    • Order edited

API Version Management Updates​

• Deprecation Notice: The following metafield APIs will be discontinued. If you are currently using these APIs, please migrate to the replacement APIs as soon as possible to ensure stable operation.
  • Add a secondary metafield
  • Update a secondary metafield
  • Delete a secondary metafield
  • Get metafields of a resource
  • Get a metafield
  • Get the metafield count

June 2025​

Product Management​

• Webhook Updates: Three new events, Taxonomy collection note created, Taxonomy collection note deleted, and Taxonomy collection note updated, have been added to help you manage your collection structure more efficiently.
• Taxonomy Collection Node Query: The Storefront API now supports retrieving detailed information about a taxonomy collection node using its node ID.

Marketing Management​

• Webhook Updates: Three new events, Price rule updated, Price rule created, and Discount code added, have been added to help you manage discount campaigns more effectively.

API Version Management Updates​

• v20251201 Release: The new API version v20251201 is now officially released. The previous version, v20250601, has been moved to candidate status. For details, please refer to the API versioning guide.
• Deprecated Fields Notice: Starting from version v20250601, some fields in the following APIs have been deprecated. Please update your integration to ensure stable operation.
  • Query all fulfillments for an order
  • Update tracking number
  • Update fulfillment tracking information
  • Create a fulfillment for the fulfillment order (single or batch)

May 2025​

Product Management​

• Media File Upload: A new Admin REST API Initiate a file staged upload is now available. It provides the necessary upload URL and parameters to help you securely and efficiently upload media files from local sources.
• File Field Updates: The file fields in the following Admin REST APIs have been updated. The content_type now accommodates all file types, and the original_source includes support for staged upload URLs.
  • Create a file
  • Get a file
  • Get files
• Taxonomy Collection: New Admin REST API endpoints make it easier to manage product collections, improving both merchant efficiency and customer experience. The following operations are supported:
  • Create a taxonomy collection node
  • Update a taxonomy collection node
  • Get a taxonomy collection node
  • Get child taxonomy collection nodes
  • Delete a taxonomy collection node
  • Query taxonomy of the store

Order Management​

• Order Query Enhancement: The Admin REST API Get orders now includes a new channel_refund_id field in the response body. This makes it easier to reconcile refunds by channel.

Metafield Management​

• Metafield Query: A new Storefront API Metafields Query is now available, allowing you to retrieve product metafield data more easily on the storefront.

Fulfillment Management​

• Webhook Enhancements: The Fulfillment order creation and Fulfillment order update events have been updated to include the service_code, shipping_rate_name, and shipping_strategy_name fields.

Documentation Improvements​

• URL Structure Optimization: Developer documentation URLs are now more structured and readable, making it easier to identify the functionality by just looking at the link. Old URLs remain accessible.

March 2025​

Customer Management​

• Customer Info Query: The Admin REST APIs below have been updated to include a new provinceCode_V2 field in the response body. The provinceCode_V2 uses the two-letter province codes based on the ISO-3166-2 standard.
  • Check customer information via email
  • Query customer address details 2.0
  • Batch query customer address 2.0

Transaction Management​

• Webhook Updates: Two new webhook events have been added. These can help you track checkout payments in real time and improve your transaction management.
  • Create checkout payments
  • Update checkout payments

API Version Management​

• Private App Webhook Subscription Rules Update: Starting at the end of April 2025, the SHOPLINE Admin will only support private apps using Webhooks version v20240601 or later. Existing subscriptions will continue to function, but all changes or new subscriptions must comply with the updated version requirements. Ensure you use the correct version for future updates.

February 2025​

SHOPLINE Payments​

• Store Transaction Records: You can now utilize the Admin REST API to query store transaction records, including payments, refunds, and disputes. This helps you better track and manage transactions.

Admin REST API​

• New Code Field for Error Responses: Starting at the end of March 2025, the Admin REST API will include a new Code field in error responses. This will help you accurately identify error codes and related information when an API call fails.

January 2025​

Order Management​

• Order Creation: The Admin REST API Create an order now includes a new company_location_id field in the request body, allowing you to specify the company location ID for B2B orders.

Customer Management​

• Blacklist Management: You can now utilize the Admin REST API to add a customer to the blacklist or remove a customer from the blacklist.

SHOPLINE Payments​

• Billing Record Query: The Admin REST API Query the billing records of SHOPLINE Payments account has been updated to include new fields: exchange_rate, settlement_amount, and settlement_currency in the response body. This update provides you with more detailed billing information.

Size Chart App​

• Size Chart Management: The Admin REST API Create a size chart, Update a size chart, and Query size charts in batch have been updated to include the new languages and tabs fields. This enhancement increases flexibility for you in managing size chart data.

December 2024​

Product Management​

• Custom URL Query: The Admin REST APIs below have been updated to include a new path field in the response body, enabling you to query the custom URL path for the page.

  • Bulk query products

  • Query single product

  • Query product information in a certain collection

  • Query collection information by ID

  • Query manual collection attributes by ID

  • Query intelligent collection attributes by ID

  • Batch query manual collection

  • Batch query intelligent collection

November 2024​

Market Management​

• Product List Management: You can now utilize the Admin REST API to query current market products, add new products to the market, and remove existing products from the market.

Localization Management​

• Supported Languages: You can now utilize the Admin REST API and Admin GraphQL API to retrieve a list of currently supported languages for your store, including active and inactive languages. This data helps you configure the language scope of your application development.

Multi-Language Translator App​

• Corpus Field Types: You can now utilize the Admin REST API to Get store translation data and filter them for specific use cases.

October 2024​

Store Management​

• Staff Information Access: You can now retrieve information about your store staff via the Admin GraphQL API if you are on the Enterprise Plan.

Member System App​

• Webhook Event Updates: You can now receive real-time updates via webhooks for the following events if you are on the Member System App with Pro Plan.

  • Gift Card Updates

  • Paid Membership Updates

  • Store Credit Updates

  • Point Updates

  • Membership Level Updates

  • Successful Invitation

September 2024​

Store Management​

• Operation Log Access: You can now access the operation logs.

  • Retrieve a list of store operation logs

  • Query a specific log based on a log ID

  • Query the total number of store operation logs

August 2024​

Store Management​

• Staff Information Access: You can now retrieve information about your store staff via the Admin REST API if you are on the Enterprise Plan.

Order Management​

• Purchase Order Number Visibility: You can now access the Purchase Order number associated with B2B orders and B2B draft orders through the Admin REST API.

• Webhook Enhancements: The Order Webhook and Draft Order Webhook have been updated to include the Purchase Order number field, providing more comprehensive order data.

Product Management​

• Currency Code Flexibility: You can now configure the product price currency for your B2B company location catalogs using the Currency Code field.

• Webhook Enhancements: The Catalog Webhook has been updated to include the Currency Code field, providing more detailed information about product pricing and currency preferences.