Skip to content

DEVDOCS-6658 Various fixes in B2B docs #1216

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.

Sign up for GitHub

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

Merged
TomA-R merged 1 commit into from
Dec 30, 2025
Merged

DEVDOCS-6658 Various fixes in B2B docs #1216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/b2b-edition/models/invoice_portal/invoice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ properties:
quantity:
type: string
minLength: 1
description: product qyantity
description: product quantity
unitPrice:
type: object
description: product unit price
Expand Down
2 changes: 1 addition & 1 deletion docs/b2b-edition/models/order/order-product.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ properties:
description: SKU's ID
options:
type: string
description: Detail infomation of SKU
description: Detailed information of SKU
example: '[{"id": 715, "option_id": 41, "order_product_id": 670, "product_option_id": 121, "display_name": "Gauge", "display_value": "12", "value": "123", "type": "Multiple choice", "name": "Gauge1576218034-477", "display_style": "Dropdown"}, {"id": 716, "option_id": 42, "order_product_id": 670, "product_option_id": 122, "display_name": "Leg 1 (inches)", "display_value": "5", "value": "5", "type": "Text field", "name": "Leg-1-(inches)1576218034-477", "display_style": ""}]'
productBrandName:
type: string
Expand Down
2 changes: 1 addition & 1 deletion docs/b2b-edition/specs/api-v2/openAPI.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2313,7 +2313,7 @@ paths:
type: string
- name: channelId
in: query
description: BigComerce channel id
description: BigCommerce channel id
schema:
type: number
responses:
Expand Down
18 changes: 9 additions & 9 deletions docs/b2b-edition/specs/api-v3/address/address.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ paths:
description: |-
Retrieves country information based on the country name or two-letter code entered in the parameters. The response can be used to provide a valid country name or code in Company addresses.

Use the `searchType` parameter to specify whether you are searching by a country's name or its two-letter [ISO code](https://www.iso.org/obp/ui/#search), and then add the appropriate value for the country to the `q` parameter. This endpoint only accepts country name values in English, but you can set the `searchBy` paramteter to `1` to retrieve country information with the standard ISO code instead.
Use the `searchType` parameter to specify whether you are searching by a country's name or its two-letter [ISO code](https://www.iso.org/obp/ui/#search), and then add the appropriate value for the country to the `q` parameter. This endpoint only accepts country name values in English, but you can set the `searchBy` parameter to `1` to retrieve country information with the standard ISO code instead.
parameters:
- schema:
type: integer
Expand Down Expand Up @@ -387,7 +387,7 @@ paths:
- $ref: "#/components/schemas/responseSuccess"
- properties:
data:
$ref: '#/components/schemas/addressFields_GET'
$ref: '#/components/schemas/addressFields_GET'
required:
- code
- data
Expand Down Expand Up @@ -439,7 +439,7 @@ paths:
phoneNumber: "512-200-1234"
zipCode: "78704"
addressLine1: "512 Bluebonnet Lane"
addressline2: "Building 1"
addressLine2: "Building 1"
city: "Austin"
stateName: "Texas"
countryName: "United States"
Expand Down Expand Up @@ -680,7 +680,7 @@ paths:
phoneNumber: "512-200-1234",
zipCode: "78704",
addressLine1: "512 Bluebonnet Lane",
addressline2: "Building 1",
addressLine2: "Building 1",
city: "Austin",
stateName: "Texas",
countryName: "United States",
Expand All @@ -704,7 +704,7 @@ paths:
phoneNumber: "512-100-1000",
zipCode: "78726",
addressLine1: "737 Lone Star Road",
addressline2: "Suite 200",
addressLine2: "Suite 200",
city: "Austin",
stateName: "Texas",
countryName: "United States",
Expand Down Expand Up @@ -733,7 +733,7 @@ paths:
- $ref: "#/components/schemas/responseSuccess"
- properties:
data:
$ref: '#/components/schemas/addressFields_GET'
$ref: '#/components/schemas/addressFields_GET'
required:
- code
- data
Expand All @@ -750,7 +750,7 @@ paths:
phoneNumber: "512-200-1234",
zipCode: "78704",
addressLine1: "512 Bluebonnet Lane",
addressline2: "Building 1",
addressLine2: "Building 1",
city: "Austin",
stateName: "Texas",
countryName: "United States",
Expand Down Expand Up @@ -778,7 +778,7 @@ paths:
phoneNumber: "512-100-1000",
zipCode: "78726",
addressLine1: "737 Lone Star Road",
addressline2: "Suite 200",
addressLine2: "Suite 200",
city: "Austin",
stateName: "Texas",
countryName: "United States",
Expand Down Expand Up @@ -1085,7 +1085,7 @@ components:
type: boolean
description: "Indicates whether the address is the default billing address."
example: true
isDefaultShipping:
isDefaultShipping:
type: boolean
description: "Indicates whether the address is the default shipping address."
example: true
Expand Down
4 changes: 2 additions & 2 deletions docs/b2b-edition/specs/api-v3/channel/channel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,12 +194,12 @@ components:
createdAt:
type: string
format: date-time
description: "The [Unix Timestap](https://www.unixtimestamp.com/) creation date for the channel."
description: "The [Unix Timestamp](https://www.unixtimestamp.com/) creation date for the channel."
example: "1750437336"
updatedAt:
type: string
format: date-time
description: "The [Unix Timestap](https://www.unixtimestamp.com/) last update date for the channel."
description: "The [Unix Timestamp](https://www.unixtimestamp.com/) last update date for the channel."
example: "1750437336"
securitySchemes:
X-Store-Hash:
Expand Down
34 changes: 17 additions & 17 deletions docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,25 +134,25 @@ paths:
description: Sales Tax
orderDate: 1616809386
billingAddress:
city: 成都
state: District of Columbia
city: Los Angeles
state: California
country: United States
street1: tianfuwujie
street2: ruanjianyuan
zipCode: '123'
lastName: xu
firstName: stanton
street1: 123 Main Street
street2: Suite 200
zipCode: '90210'
lastName: Bloggs
firstName: Joe
customFields: {}
customerFields: {}
shippingAddresses:
- city: 成都
state: District of Columbia
- city: Los Angeles
state: California
country: United States
street1: tianfuwujie
street2: ruanjianyuan
zipCode: '123'
lastName: xu
firstName: stanton
street1: 123 Main Street
street2: Suite 200
zipCode: '90210'
lastName: Bloggs
firstName: Joe
customFields: {}
details:
shipments: []
Expand Down Expand Up @@ -323,7 +323,7 @@ paths:
'400':
value:
code: 400
data:
data:
id: 33
meta:
message: Bad Requests Error
Expand Down Expand Up @@ -622,7 +622,7 @@ paths:
minLength: 1
customFields:
type: object
description: Adds custom information to the product.
description: Adds custom information to the product.
properties:
key:
type: string
Expand Down Expand Up @@ -947,7 +947,7 @@ paths:
description: address ID
shipDate:
type: string
description: shipment
description: shipment
shipVia:
type: string
trackingNumber:
Expand Down
2 changes: 1 addition & 1 deletion docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ components:
type: string
enum: ["DESC","ASC"]
default: "DESC"
description: "Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order."
description: "Determines whether results will be sorted in ascending (`ASC`) or descending (`DESC`) order."
responses:
'404':
description: NOT FOUND
Expand Down
6 changes: 3 additions & 3 deletions docs/b2b-edition/specs/storefront/app/company.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ paths:
adminEmail: "john.doe@acme.com"
adminPhoneNumber: "555-987-6543"
catalogId: "catalog-123"
acceptCrreationEmail: '0'
acceptCreationEmail: '0'
extraFields:
- fieldName: string
fieldValue: string
Expand Down Expand Up @@ -869,7 +869,7 @@ paths:
adminEmail: "john.doe@acme.com"
adminPhoneNumber: "555-987-6543"
catalogId: "catalog-123"
acceptCrreationEmail: '0'
acceptCreationEmail: '0'
extraFields:
- fieldName: string
fieldValue: string
Expand Down Expand Up @@ -1499,7 +1499,7 @@ paths:
phoneNumber: '555-123-4567'
role: '0'
email: example@example.com
user not sxist:
user not exist:
value:
code: 200
message: Success
Expand Down
12 changes: 6 additions & 6 deletions docs/b2b-edition/specs/storefront/app/sales-rep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,12 +432,12 @@ paths:
- companyName: company name
bcGroupName: bc group name
description: Desc
companyEmail: 1149847234@qq.com
companyEmail: some-email@example.com
addressLine1: ''
addressLine2: ''
city: shanxi
state: weinan
zipCode: pucheg
city: Los Angeles
state: California
zipCode: 90210
country: ''
companyId: '5498'
catalogId: '11'
Expand Down Expand Up @@ -544,8 +544,8 @@ paths:
bcGroupName: bc group name
description: ''
companyEmail: example@example.com
addressLine1: adress line 1
addressLine2: adress line 2
addressLine1: address line 1
addressLine2: address line 2
city: Sewell
state: New Jersey
zipCode: '92620'
Expand Down
28 changes: 14 additions & 14 deletions docs/b2b-edition/specs/storefront/invoice_protal/invoice/invoice.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ components:
quantity:
type: string
minLength: 1
description: product qyantity
description: product quantity
unitPrice:
type: object
description: product unit price
Expand Down Expand Up @@ -494,25 +494,25 @@ paths:
description: Sales Tax
orderDate: 1616809386
billingAddress:
city: 成都
state: District of Columbia
city: Los Angeles
state: California
country: United States
street1: tianfuwujie
street2: ruanjianyuan
zipCode: '123'
lastName: xu
firstName: stanton
street1: 123 Main Street
street2: Suite 200
zipCode: '90210'
lastName: Bloggs
firstName: Joe
customFields: {}
customerFields: ''
shippingAddresses:
- city: 成都
- city: Los Angeles
state: District of Columbia
country: United States
street1: tianfuwujie
street2: ruanjianyuan
zipCode: '123'
lastName: xu
firstName: stanton
street1: 123 Main Street
street2: Suite 200
zipCode: '90210'
lastName: Bloggs
firstName: Joe
customFields: {}
details:
shipments: []
Expand Down
Loading