Adds several endpoints to support wallet pay in the Checkout Frontend API. These endpoints enable Bold to communicate with the wallet pay provider in order to properly create and capture orders.
74 posts tagged with "Non-Breaking"
View All Tags2023-11-30 — Add discounts field for platform connectors
The discounts
field is the list of discounts for an order. It is a list which contains the applied discounts to the order with details about the each discount.
2023-11-22 — Create orders in specified payment gateways
Create Payment Gateway Order allows merchants to directly create an order on a payment gateway.
2023-11-21 — Add wallet_pay_type field
The Checkout Frontend API now includes wallet_pay_type
in payment objects to indicate if the payment was created by a wallet/express payment provider.
2023-10-27 — Add `api_session_id` field
A new optional field has been added to the Initialize Order and Create Order endpoints.
This will be used to track order completion rates. For more information, refer to Configure Checkout Flow Metrics.
2023-10-11 — Add platform_friendly_id field
The platform_friendly_id
field is a unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform. Please note platform_id
should be used only for the internal identifier of the order on the platform.
2023-10-10 — Update tax_total field in the External Payment Gateway Connector API
In the External Payment Gateway Connector API, the tax_total
field in the Auth request payload now includes total shipping taxes (where applicable) on the order. The initial value only contained total product taxes.
Refer to the specifications for more information:
2023-09-27 — Add new features to Lightweight Frontend Experience Elements
Adds the following new features for Lightweight Frontend Experience (LiFE) elements:
- New
dropdown
anddatepicker
types of LiFE element. - New locations on the checkout and thank you page.
- Support regular expression for
text
andtextarea
elements.
2023-09-27 — New capture and refund endpoints that act on specific payments
Adds new endpoints that allow a merchant to capture and refund payments, specified by a payment identifier.
Refer to the specifications for more information:
2023-09-22 — Add plugin action set_display_currency
You can now use a plugin action to set the displayed currency and/or exchange rate on the order. These values are added to the order's application state.
Bold Checkout does NOT use these values to update the order_total
or currency
in the application state. The frontend is responsible for using these values to calculate the display the correct price to the shopper.
For more information please see the set_display_currency plugin action.
2023-09-14 — Add self-service CORS endpoints
Adds self-service support for managing the domains that are permitted to call the Bold Checkout APIs. You can add a domain to the Cross-Origin Resource Sharing (CORS) allowlist using the Add Domain to CORS Allowlist endpoint.
2023-09-08 — Add Batch Process endpoint
Adds batch processing support for select Checkout Frontend endpoints.
2023-08-29 — Add saved payment method management endpoints
The Checkout Admin API now includes two endpoints, List Saved Payment Methods and Delete Saved Payment Method, to manage customers' saved payment methods.
2023-08-22 — Add new plugin event payments_preauthorized
During the checkout process, the plugin event payments_preauthorized
can now be sent to plugins after the payment preauthorization step.
2023-08-17 — Add localization for names and descriptions of product data
For products configured on the platform in multiple languages, product data now includes localization data in those languages for use by API consumers.
2023-08-08 — Improve enforcement of tax calculations
Taxes must be calculated on an order before the order is processed. Bold Checkout added internal validation to strongly enforce this requirement.
2023-07-25 — Add capability for Lightweight Frontend Experience Elements
Adds the ability to add, edit, and delete Checkout Lightweight Frontend Experience (LiFE) Elements.
2023-07-24 — Add endpoint for payment method management
Adds the Get PMMC Session endpoint to the Checkout Admin API.
2023-07-14 — Add update_line_item_quantity Subscription Adjustment type
Developers can now update line item quantity in future orders as one-time or ongoing modifications, or on a customized schedule of their own.
2023-07-14 — Add public_order_id attribute to Shop General Settings
Adds a new public_order_id
field to the Shop General Settings entity of the Checkout Admin API.
2023-07-10 — Add latest parameter to List Selection Options endpoint
The List Selection Options endpoint now uses the optional latest
query parameter to return the latest subscription group that a product was added to.
2023-06-26 — Add note_attributes and cart_params to select overrides
The Inventory, Shipping, and Tax Overrides now contain the note_attributes
and cart_params
from the Order metadata.
2023-06-20 — Additional information about Payment Methods
The Get Payment Method endpoint now returns additional information, such as customer's name and billing address, when this data is available.
2023-06-13 — New endpoint to uninstall an integration programatically
Adds the Uninstall Integration endpoint to the Shops API. This endpoint allows an API consumer (typically an integration developer) to uninstall an integration for a shop by using the same token issued during its installation.
2023-06-12 — New Failure Code for Subscriptions
For Subscriptions endpoints, the new out_of_stock_product
error code is now available in the last_failure_code
field when a recurrence order cannot be placed due to missing products on stock.
2023-05-26 — Add External Payment Gateway endpoints
Adds the External Payment Gateway endpoints to the Checkout Admin API. These endpoints allow developers to integrate payment gateways not supported by Bold in their store checkout.
2023-05-23 — Add support for Adobe Commerce
Bold Checkout now supports users of both Adobe Commerce (formerly known as Magento 2) and Magento Open Source.
2023-05-18 — Subscriptions Future Order API improvements
To support the recent introduction of our Subscription Adjustment API, several improvements have been made to the Future Order endpoints of Subscriptions.
2023-05-18 — Subscription Adjustment API
Developers now have the ability to add line items to future orders as one-time or ongoing modifications, or on a customized schedule of their own.
2023-05-18 — Add Remote State Authority API
Adds the Remote State Authority API. This API enables platform developers to fully control the state of orders during checkout by interfacing directly with the platform.
2023-05-10 — Modified Tax Zone Settings endpoints
The tax zone settings endpoints are now a sub-route of zones. Refer to Checkout Admin.
2023-05-09 — Add Warehouse Read, Update, and Delete endpoints
Adds support for reading, updating, and deleting warehouses using the Checkout Admin API. The warehouse routes are now sub-routes of the zone routes. The route for Create Warehouse has been modified to this effect.
2023-05-02 — Add Zone Read, Update, and Delete endpoints
Adds support for reading, updating, and deleting zones using the Checkout Admin API.
2023-05-01 — Price is optional when updating Subscription Line Items
When updating a Subscription Line Item, the price
field is now optional.
2023-04-21 — Add Platform Connector Sync endpoints
Adds 3 new endpoints to independently sync products, customers, and orders from a platform connector on behalf of a shop into Bold.
2023-04-21 — Add Tax Zone Settings endpoints
Adds support for configuring tax zone settings using the Checkout Admin API.
2023-04-21 — Gift Card Enhancements
Adds various features and improvements to Bold gift card functionality, including better formatting of data in Bold Checkout admin, support for setting gift card recipient data through the API, and a new endpoint to query for a gift card balance.
Refer to Manage Gift Cards for more information about gift cards.
2023-04-05 — Add List Selection Options endpoint
Adds the List Selection Options endpoint, which retrieves some or all selection options for the active subscription groups on a given store.
2023-04-04 — Add Zone and Warehouse endpoints
Zones (tax, shipping, and warehouse) and warehouses can be created using the Checkout Admin API.
2023-04-04 — Add endpoint to Create Order
Adds the Create Order endpoint.
2023-03-27 — Add Handle Amendment endpoint
The Handle Amendment endpoint directs Bold Checkout to recalculate the outstanding balance of the order compared to what was authorized in the Pre-Process Order endpoint and attempt to add an additional payment if required.
2023-03-09 — Add Event-Actor-Type header to webhook callbacks
Callbacks to webhooks registered using the Create Webhook Subscription endpoint now contain a header called Event-Actor-Type
. This header indicates the type of user that triggered the webhook event.
2023-03-07 — Line item Properties for Gift Cards
Adds the description of how to include orders with gift cards to: Initialize Order, Create Order and Add List Item endpoints. Also allows the gift card properties to be shown in the application state returned from most Checkout Frontend and Backend endpoints
2023-03-02 — Add new subscriptions webhook topic for line items added
A new webhook topic is now available for subscription line items added. Add this webhook via the Create Webhook Subscription endpoint.
2023-02-07 — Add address deleted_at
The subscriptions shipping_address
and billing_address
objects now contain a field called deleted_at
.
2023-02-01 — Add subscription order_count
The subscription
now contains a field called order_count
. This field gives the current count of orders created for a subscription.
2023-01-20 — Add shipping_code field
The code of shipping method for the order. Each store defines its own shipping codes.
2023-01-17 — Add endpoint for creating subscription line items
Adds the Create Line Items endpoint.
2023-01-09 — Add is_processed to application_state object
The application_state
now contains a field called is_processed
. This field indicates whether the order has been processed.
2022-12-23 — Add source attribute to discounts in Checkout
Adds new property source
in discount
objects in the Checkout Frontend API to identify the source of the discount code.
2022-12-14 — Add flow_id to application state
Adds the flow_id
field to the application state returned from most Checkout Frontend and Backend endpoints.
2022-12-02 — Add new Verification endpoint to Platform Connector API
Adds a new Verification endpoint to the Platform Connector API Specification.
2022-12-02 — Add new Platform Connector API for configuration
Adds the Platform Connector: Integration Configurations API. This API enables Platform Connector developers to register their connector's destinations via API.
2022-12-02 — Add endpoint to Cancel Order
Adds the Cancel Order endpoint.
2022-11-14 — Add Checkout Order ID to application state
Adds Bold Checkout's order_id
to the application state.
2022-11-10 — Add endpoints for API overrides
Adds a series of endpoints to create, update, and delete API overrides.
2022-10-31 — Add endpoint for updating prepaid metadata
Adds the Update Line Item Prepaid Metadata endpoint.
2022-10-25 — Add endpoint for creating line item attributes
Adds the Create Line Item Attributes endpoint.
2022-10-19 — Add plugin_event_failed code to Subscriptions last_failure_code
Adds a plugin_event_failed
failure code to the possible list of last failure codes in the Subscription entity of the Subscriptions API.
2022-10-18 — Add endpoint for prepaid subscriptions
Adds the Create Line Item Prepaid Metadata endpoint to the Subscriptions API. This allows API users to convert subscriptions to prepaid.
2022-10-17 — Remove placed_at attribute from Create Order request
Removes the placed_at
attribute from the Platform Connector: Create Order request body.
2022-10-13 — Add address_use to Platform Connector customer endpoints
Adds the address_use
field to address objects in the Platform Connector customer endpoints. This field denotes whether an address is for "shipping" or "billing".
2022-09-29 — Add User-Agent header to Platform Connector endpoints
Adds the User-Agent
header, which is sent with all Platform Connector API calls from Bold.
2022-09-27 — Add email query param to List Customer endpoint
Adds an optional email query parameter to the List Customers endpoint to filter the results based on that email.
2022-09-23 — Add platform_id to order payment transaction request
Adds an optional platform_id to the transaction schema in the Platform Connector: Orders API
2022-09-16 — Add additional failure codes to Subscription entity
Adds a few new failure codes to the Subscription entity of the Subscriptions API
2022-09-13 — Add last_failure fields to Subscription entity
Adds three optional fields to the Subscription entity of the Subscriptions API
2022-09-01 — Discount code support for Create Subscription endpoint
Adds support for the subscription.discount_code
field in the payload of the Create Subscription endpoint of the Subscriptions API.
2022-09-01 — Add placed_at to Subscription
Adds a new placed_at
field to the Subscription entity of the Subscriptions API.
2022-08-02 — Add fees to application_state object
Fees are now included in the application_state
. Add fees can be added to orders by using the add_fee plugin action.
2022-07-29 — Add Remove Gift Card Payment Endpoint
The Remove Gift Card Payment endpoint removes a gift card payment from an order.
2022-07-21 — Subscription order note
Add an order_note
field to the Subscriptions object. This feature ensures that the customer order note added at the time of the initial order is carried through to recurring orders and that it can be updated via the API.
This field is supported on stores using Shopify Checkout only.
2022-07-14 — Add Pre-Process Order endpoint
The Pre-Process Order endpoint allows Bold Checkout to complete full order validation and payment authorization, without actually processing the order.
2022-07-11 — Add cart_customer_id field
Add the cart_customer_id
field to the response body of the Initialize Order endpoint.