BigCommerce API: How to retrieve and update Checkout Settings

Beehexa will show you How to retrieve and update Checkout Settings on Bigcommerce using Postman in this article. Following this process, you can create, retrieve and update an order with all the information you want using Postman.

Retrieve Checkout Settings

https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settings

Log in to Postman, choose a workspace, and open a new request tab. Here, select GET and paste the URL:  

https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settings

Replace Store hash with your store hash

Now in the header section, fill in the information about:

• X-auth-token 
• Accept
• Content-type

After all, click send button to see the result:

{
    "data": {
        "custom_checkout_script_url": "",
        "custom_order_confirmation_script_url": "",
        "order_confirmation_use_custom_checkout_script": true,
        "custom_checkout_supports_uco_settings": null
    },
    "meta": {}
}

Update Checkout Settings

Select PUT

https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/settings

Replace Store hash with your store hash

Now in the header section, fill in the information about:

• X-auth-token 
• Accept
• Content-type

In the body section, you will fill information that you want to change in the body part so select the body, Click on “raw” to fill in the data; remember to change the “text” to “JSON.”

• Custom_checkout_script_url : string
  Custom checkout script URL to replace our default checkout. To reset a store to an optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.
• Order_confirmation_use_custom_checkout_script: boolean
  When order_confirmation_use_custom_checkout_script=true, the default custom_order_confirmation_script_url defaults to an empty string.
• Custom_order_confirmation_script_url: string
  Custom order confirmation script URL to replace the default order confirmation. To reset a store to an optimized one-page checkout, pass an empty string for custom_checkout_script_url and custom_order_confirmation_script_url.
• Custom_checkout_supports_uco_settings: boolean
  Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings.

Example:

{

  "custom_checkout_script_url": "https://www.hexasync.com/",

  "order_confirmation_use_custom_checkout_script": true,

  "custom_order_confirmation_script_url": "string",

  "custom_checkout_supports_uco_settings": true

}

Then Just click send to send the request

The API will return the data:

In conclusion, the above are all steps to retrieve and update Checkout Settings BigCommerce using Postman. Please comment below or refer to our BigCommerce API documentation if you have any questions. Finally, I hope you can achieve it!