Public APIs for Uploading

When you create rules using Public APIs, it's essential to follow these steps to upload them to your store and make them effective. You have two options for this:

Option 1: Sending API Requests to the below endpoints

Option 2: Access the app and click Upload to Theme button on the Dashboard page.

I. Upload Custom Pricing rules

Upload all the Custom Pricing rules to your store.

POST https://b2b-solution-public-api.bsscommerce.com/api/v1/rule/upload

When the request is sent, all enabled rules will be uploaded to the active theme.

This request has a rate limit of 5 mins/request.

Request Body

Name	Type	Description
domain*	String	Your store's myshopify domain
accessKey*	String	Your API Access Key

200: OK When the rules are uploaded successfully

429: Too Many Requests When the requests you sent excess the rate limit (5 mins/request)

Example request body:

{ 
  "domain": "bsscommerce-store.myshopify.com", 
  "accessKey": "yt1pRFAU8ARdwQORhz/Ww7vyS+xxxxxxxxxxxxxx" 
}

II. Upload Quantity/Amount Breaks rules

Upload all the Quantity/Amount Breaks rules to your store.

POST https://b2b-solution-public-api.bsscommerce.com/api/v1/qb/rule/upload

When the request is sent, all enabled rules will be uploaded to the active theme.

This request has a rate limit of 5 mins/request.

Request Body

Name	Type	Description
domain*	String	Your store's myshopify domain
accessKey*	String	Your API Access Key

200: OK When the rules are uploaded successfully

429: Too Many Requests When the requests you sent excess the rate limit (5 mins/request)

Example request body:

{ 
  "domain": "bsscommerce-store.myshopify.com", 
  "accessKey": "yt1pRFAU8ARdwQORhz/Ww7vyS+xxxxxxxxxxxxxx" 
}

III. Upload Price List rules

Upload all the Price Lít rules to your store.

POST https://b2b-solution-public-api.bsscommerce.com/api/v1/pl/rule/upload

When the request is sent, all enabled rules will be uploaded to the active theme.

This request has a rate limit of 5 mins/request.

Request Body

Name	Type	Description
domain*	String	Your store's myshopify domain
accessKey*	String	Your API Access Key

200: OK When the rules are uploaded successfully

429: Too Many Requests When the requests you sent excess the rate limit (5 mins/request)

Example request body:

{ 
  "domain": "bsscommerce-store.myshopify.com", 
  "accessKey": "yt1pRFAU8ARdwQORhz/Ww7vyS+xxxxxxxxxxxxxx" 
}