Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NO TICKET [update] add Get all Bulk Pricing Rules endpoint #800

Merged
merged 7 commits into from
Feb 6, 2025
68 changes: 68 additions & 0 deletions reference/catalog/products_catalog.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3424,6 +3424,74 @@ paths:
type: price
amount: 1
meta: {}
get:
tags:
- Bulk pricing rules
summary: Get all Bulk Pricing Rules
description: Returns all *Bulk Pricing Rules*. Optional parameters can be passed in.
operationId: getAllBulkPricingRules
parameters:
- $ref: '#/components/parameters/IncludeFieldsParam'
- $ref: '#/components/parameters/ExcludeFieldsParam'
responses:
'200':
description: ''
content:
application/json:
schema:
title: 'Get All Bulk Pricing Rule Response'
type: object
properties:
data:
allOf:
- type: object
properties:
id:
type: integer
description: Unique ID of the *Bulk Pricing Rule*. Read-Only.
readOnly: true
required:
- id
- $ref: '#/components/schemas/bulkPricingRule_Full'
meta:
$ref: '#/components/schemas/metaCollection_Full'
example:
data:
id: 83
quantity_min: 1
quantity_max: 3
type: price
amount: 1
meta:
pagination:
total: 2
count: 2
per_page: 50
current_page: 1
total_pages: 1
links:
current: '?page=1&limit=50'
'404':
description: |
The resource or parent resource was not found.
content:
application/json:
schema:
title: Not Found
type: object
properties:
status:
type: integer
description: |
404 HTTP status code.
title:
type: string
description: The error title describing the particular error.
type:
type: string
instance:
type: string
description: Error payload for the BigCommerce API.
'/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}':
get:
tags:
Expand Down