Adds the flow_id field to the application state returned from most Checkout Frontend and Backend endpoints.
Changelog
info
Bold occasionally releases changelog entries that have a
When working on a production store, never use a
Bold-API-Version-Date in the future. When working on a production store, never use a
Bold-API-Version-Date that is in the future. Doing so may cause you to inadvertently opt-in to undocumented changes. Use a future Bold-API-Version-Date in non-production or development environments only.📫 Subscribe for updates: RSS | ATOM | JSON
- All
- Breaking
- Non-Breaking
All changes
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.
note
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.
Nothing to see here...
There are no breaking changes👍🏽 Non-Breaking
note
Non-breaking (backwards-compatible) changes to an API apply to all versions of that API. These changes are immediately available to you. You do not need to update the
Bold-API-Version-Date header in your API calls.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.
note
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.