From ca7d4be02dd83808888022e0a9d9947f1f5170c4 Mon Sep 17 00:00:00 2001 From: Tom Arbesser-Rastburg Date: Tue, 30 Dec 2025 11:44:58 +1100 Subject: [PATCH] DEVDOCS-6658 Various fixes in B2B docs --- .../models/invoice_portal/invoice.yaml | 2 +- .../models/order/order-product.yaml | 2 +- docs/b2b-edition/specs/api-v2/openAPI.yaml | 2 +- .../specs/api-v3/address/address.yaml | 18 ++-- .../specs/api-v3/channel/channel.yaml | 4 +- .../invoice_management/invoice/invoice.yaml | 34 +++---- .../specs/api-v3/super_admin/super_admin.yaml | 2 +- .../specs/storefront/app/company.yaml | 6 +- .../specs/storefront/app/sales-rep.yaml | 12 +-- .../invoice_protal/invoice/invoice.yaml | 28 +++--- .../specs/storefront/storefront.yaml | 89 ++++++++++--------- .../specs/storefront/storefront/company.yaml | 6 +- .../specs/storefront/storefront/order.yaml | 28 +++--- .../specs/storefront/storefront/rfq.yaml | 22 ++--- .../b2b/company-account-registration.mdx | 8 +- 15 files changed, 134 insertions(+), 129 deletions(-) diff --git a/docs/b2b-edition/models/invoice_portal/invoice.yaml b/docs/b2b-edition/models/invoice_portal/invoice.yaml index b76baf261..b97ef7639 100644 --- a/docs/b2b-edition/models/invoice_portal/invoice.yaml +++ b/docs/b2b-edition/models/invoice_portal/invoice.yaml @@ -397,7 +397,7 @@ properties: quantity: type: string minLength: 1 - description: product qyantity + description: product quantity unitPrice: type: object description: product unit price diff --git a/docs/b2b-edition/models/order/order-product.yaml b/docs/b2b-edition/models/order/order-product.yaml index d45533088..003a65f3a 100644 --- a/docs/b2b-edition/models/order/order-product.yaml +++ b/docs/b2b-edition/models/order/order-product.yaml @@ -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 diff --git a/docs/b2b-edition/specs/api-v2/openAPI.yaml b/docs/b2b-edition/specs/api-v2/openAPI.yaml index 6eb61625e..27dc8dd1a 100644 --- a/docs/b2b-edition/specs/api-v2/openAPI.yaml +++ b/docs/b2b-edition/specs/api-v2/openAPI.yaml @@ -2313,7 +2313,7 @@ paths: type: string - name: channelId in: query - description: BigComerce channel id + description: BigCommerce channel id schema: type: number responses: diff --git a/docs/b2b-edition/specs/api-v3/address/address.yaml b/docs/b2b-edition/specs/api-v3/address/address.yaml index 1729fe64c..45c423430 100644 --- a/docs/b2b-edition/specs/api-v3/address/address.yaml +++ b/docs/b2b-edition/specs/api-v3/address/address.yaml @@ -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 @@ -387,7 +387,7 @@ paths: - $ref: "#/components/schemas/responseSuccess" - properties: data: - $ref: '#/components/schemas/addressFields_GET' + $ref: '#/components/schemas/addressFields_GET' required: - code - data @@ -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" @@ -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", @@ -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", @@ -733,7 +733,7 @@ paths: - $ref: "#/components/schemas/responseSuccess" - properties: data: - $ref: '#/components/schemas/addressFields_GET' + $ref: '#/components/schemas/addressFields_GET' required: - code - data @@ -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", @@ -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", @@ -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 diff --git a/docs/b2b-edition/specs/api-v3/channel/channel.yaml b/docs/b2b-edition/specs/api-v3/channel/channel.yaml index f755478d2..49c7a5c8b 100644 --- a/docs/b2b-edition/specs/api-v3/channel/channel.yaml +++ b/docs/b2b-edition/specs/api-v3/channel/channel.yaml @@ -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: diff --git a/docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml b/docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml index 66858e7cc..78f9c7f87 100644 --- a/docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml +++ b/docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml @@ -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: [] @@ -323,7 +323,7 @@ paths: '400': value: code: 400 - data: + data: id: 33 meta: message: Bad Requests Error @@ -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 @@ -947,7 +947,7 @@ paths: description: address ID shipDate: type: string - description: shipment + description: shipment shipVia: type: string trackingNumber: diff --git a/docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml b/docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml index 13c16fb7b..47113bcdc 100644 --- a/docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml +++ b/docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml @@ -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 diff --git a/docs/b2b-edition/specs/storefront/app/company.yaml b/docs/b2b-edition/specs/storefront/app/company.yaml index 1864d5121..bbf4b0d96 100644 --- a/docs/b2b-edition/specs/storefront/app/company.yaml +++ b/docs/b2b-edition/specs/storefront/app/company.yaml @@ -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 @@ -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 @@ -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 diff --git a/docs/b2b-edition/specs/storefront/app/sales-rep.yaml b/docs/b2b-edition/specs/storefront/app/sales-rep.yaml index 91f1594b1..917bfcc33 100644 --- a/docs/b2b-edition/specs/storefront/app/sales-rep.yaml +++ b/docs/b2b-edition/specs/storefront/app/sales-rep.yaml @@ -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' @@ -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' diff --git a/docs/b2b-edition/specs/storefront/invoice_protal/invoice/invoice.yaml b/docs/b2b-edition/specs/storefront/invoice_protal/invoice/invoice.yaml index a739d45f1..90857ee95 100644 --- a/docs/b2b-edition/specs/storefront/invoice_protal/invoice/invoice.yaml +++ b/docs/b2b-edition/specs/storefront/invoice_protal/invoice/invoice.yaml @@ -316,7 +316,7 @@ components: quantity: type: string minLength: 1 - description: product qyantity + description: product quantity unitPrice: type: object description: product unit price @@ -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: [] diff --git a/docs/b2b-edition/specs/storefront/storefront.yaml b/docs/b2b-edition/specs/storefront/storefront.yaml index cf0b31b87..da6df5373 100644 --- a/docs/b2b-edition/specs/storefront/storefront.yaml +++ b/docs/b2b-edition/specs/storefront/storefront.yaml @@ -330,7 +330,7 @@ paths: description: Get countries list operationId: getcountries parameters: - - description: 必填 + - description: Authentication token. in: header name: authToken required: true @@ -351,7 +351,7 @@ paths: description: Get whether there is permission to modify address(storefront) operationId: getaddresseditpermission parameters: - - description: 必填 + - description: Authentication token. in: header name: authToken required: true @@ -424,7 +424,7 @@ paths: description: Check if user email can be used for current company，user info and available status will be respond.(backend) operationId: checkbackenduseremail parameters: - - description: '可选参数, 更新的时候需要，新建的时候不需要' + - description: 'Company ID. Required when updating, not required when creating a new record.' explode: true in: query name: companyId @@ -476,7 +476,7 @@ paths: schema: type: string style: form - - description: 可选参数更新的时候需要 + - description: Company ID. Required when updating; not needed when creating a new record. explode: true in: query name: companyId @@ -1408,7 +1408,7 @@ paths: type: string type: array style: form - - description: 默认DESC + - description: Sort by, default to DESC explode: true in: query name: sortBy @@ -1421,7 +1421,7 @@ paths: type: string type: array style: form - - description: 0--N 1--Y 默认"0" + - description: 0 for false, 1 for true, defaults to "0" explode: true in: query name: isShowMy @@ -1842,43 +1842,43 @@ paths: description: TEXT type: string addressInfo: - description: 地址，这是一个json字段 + description: Address information as a JSON string. type: string basePrice: - description: 产品原价 + description: Original product price. example: 120 format: int32 type: integer color: type: string companyId: - description: 需创建quote的company的id + description: The id of the company that needs to create the quote example: 1 format: int32 type: integer currency_location: - description: 符号位置 + description: Position of the currency symbol. example: left type: string currency_token: - description: 货币符号 + description: The currency symbol. example: $ type: string decimal_places: - description: 小数保留位数 + description: Number of decimal places to display. example: 2 format: int32 type: integer decimal_token: - description: 小数分隔符 + description: The decimal separator character. example: . type: string description: - description: quote的描述 - example: Test desciption + description: The quote description. + example: Test description type: string discount: - description: 报价优惠 + description: Discount applied to the quote. example: 30 format: int32 type: integer @@ -1887,19 +1887,19 @@ paths: example: '@date' type: string grandTotal: - description: 总计 + description: The grand total. example: 270 format: int32 type: integer imageUrl: - description: 产品图片地址 + description: The image URL. example: '@url' type: string money: - description: BC返回的货币信息，不做驼峰处理，直接传一个对象 + description: The currency data from BC is passed through unchanged, without camelCase conversion. type: string newPrice: - description: 报价 + description: The quoted price. example: 100 format: int32 type: integer @@ -1916,7 +1916,7 @@ paths: productList: type: string productName: - description: 产品名字 + description: The product name. example: Test Product type: string quantity: @@ -1929,7 +1929,7 @@ paths: size: type: string sku: - description: 产品sku + description: A list of product SKUs. example: - sku-001 - sku-002 @@ -1957,15 +1957,15 @@ paths: format: int32 type: integer thousands_token: - description: 千位分隔符 + description: Thousands separator character. example: ',' type: string title: - description: quote的标题 + description: The title of the quote example: Test title type: string variantId: - description: 若没有则传空 + description: List of variant IDs, or an empty array if not applicable. example: - '1' - '2' @@ -3839,9 +3839,9 @@ paths: get: deprecated: false description: Get store configs switch status - operationId: getstoreconfig的switch-status + operationId: getStoreConfigSwitchStatus parameters: - - description: 可以根据key来获取单个的 + - description: Optional key to fetch a specific configuration value. explode: true in: query name: key @@ -3919,10 +3919,13 @@ paths: /users: get: deprecated: false - description: Get user list + description: Retrieve a paginated list of users. operationId: userlist parameters: - - description: '分页的参数，开始的id，默认值为0, 正常会传递(当前页-1)*limit， 比如，要请求第5页的数据，每页10条，那么这里应该传入(5 - 1) * 10' + - description: > + Pagination starting index. Defaults to 0. + Commonly calculated as `(currentPage - 1) * limit`. + For example, requesting page 5 with 10 items per page → `(5 - 1) * 10 = 40`. explode: true in: query name: offset @@ -3932,7 +3935,7 @@ paths: format: int32 type: integer style: form - - description: 每页条数 + - description: Number of results to return per page. explode: true in: query name: limit @@ -3942,7 +3945,7 @@ paths: format: int32 type: integer style: form - - description: 搜索关键字 + - description: Search keyword (optional). explode: true in: query name: q @@ -3966,7 +3969,9 @@ paths: schema: type: string style: form - - description: 必选 + - description: > + Filter by role. Accepted values: + ["", "0", "1", "2", "3", "4"]. in: header name: authToken required: true @@ -4000,13 +4005,13 @@ paths: schema: properties: email: - example: kobe@bu.com + example: joe.bloggs@example.com type: string firstName: - example: kobe + example: Joe type: string lastName: - example: tian + example: Bloggs type: string phoneNumber: example: 17316289569 @@ -4053,7 +4058,7 @@ paths: example: '@email' type: string style: form - - description: lable在请求中对应的fieldName，这可以在浏览器中对请求进行拦截查看。例如，Customer ID这个lable对应的是customerId。 + - description: The label matches the request field name. For example, the "Customer ID" label corresponds to customerId in the request. explode: true in: query name: extraFieldName @@ -4081,7 +4086,7 @@ paths: '/users/{userId}': delete: deprecated: false - description: 'Delete user ' + description: 'Delete user' operationId: deleteuser parameters: - description: '' @@ -4102,7 +4107,7 @@ paths: - Users get: deprecated: false - description: Get user infomation by userId + description: Get user information by userId operationId: getUserInfo parameters: - description: '' @@ -4129,7 +4134,7 @@ paths: type: string put: deprecated: false - description: Update user infomation + description: Update user information operationId: updateuserinfo parameters: - description: '' @@ -4687,7 +4692,7 @@ components: readOnly: true type: integer options: - 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": ""}]' type: string productBrandName: @@ -4695,7 +4700,7 @@ components: example: LGM type: string productName: - description: 'Name of this product ' + description: 'Name of this product' example: LGM Spicy Chili Crisp type: string quantity: @@ -4759,7 +4764,7 @@ components: message: type: string example: Success - description: success reponse message. + description: success response message. x-examples: example-1: code: 200 diff --git a/docs/b2b-edition/specs/storefront/storefront/company.yaml b/docs/b2b-edition/specs/storefront/storefront/company.yaml index 95124c677..c00df29bd 100644 --- a/docs/b2b-edition/specs/storefront/storefront/company.yaml +++ b/docs/b2b-edition/specs/storefront/storefront/company.yaml @@ -220,7 +220,7 @@ paths: type: string description: "The internal name of the BigCommerce customer group assigned to the Company account. This field is read-only." example: "Tier 3 B2B Clients" - copanyStatus: + companyStatus: type: string description: "The Company’s activity status. See [Company Status Codes](https://developer.bigcommerce.com/b2b-edition/apis/rest-management/company#company-status-codes) to learn about their corresponding statuses." enum: @@ -1092,7 +1092,7 @@ paths: Equivalent Storefront GraphQL API Query: `users`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). The `role` parameter allows you to filter for users that have a predefined Company role. You can also view all users in a Company, or users with an unknown role. - parameters: + parameters: - $ref: "#/components/parameters/queryString" - $ref: "#/components/parameters/userRole" - $ref: "#/components/parameters/paginationLimit" @@ -1192,7 +1192,7 @@ paths: role: $ref: "#/components/schemas/userRole" /users/{userId}: - parameters: + parameters: - $ref: "#/components/parameters/userId" get: tags: diff --git a/docs/b2b-edition/specs/storefront/storefront/order.yaml b/docs/b2b-edition/specs/storefront/storefront/order.yaml index 561a50728..fb2c87372 100644 --- a/docs/b2b-edition/specs/storefront/storefront/order.yaml +++ b/docs/b2b-edition/specs/storefront/storefront/order.yaml @@ -101,7 +101,7 @@ paths: - 1 in: query - name: includeExtra - description: Indicates whether or not extra field information is included in the response. It defaults to including extra fields if the parmeter is omitted. `0` indicates that extra fields are included, while `1` indicates that extra fields are not included. + description: Indicates whether or not extra field information is included in the response. It defaults to including extra fields if the parameter is omitted. `0` indicates that extra fields are included, while `1` indicates that extra fields are not included. required: false example: 1 schema: @@ -512,7 +512,7 @@ paths: status: $ref: '#/components/schemas/orderStatus' subtotal_ex_tax: - type: string + type: string description: The order subtotal, excluding tax. example: "45.00" subtotal_inc_tax: @@ -615,7 +615,7 @@ paths: example: "US" currency_id: type: number - description: The unique identifier for the order's display currency. Depending on the selection, this may differ from the order's transacitonal currency. + description: The unique identifier for the order's display currency. Depending on the selection, this may differ from the order's transactional currency. example: 1 currency_code: $ref: '#/components/schemas/currencyCode' @@ -672,7 +672,7 @@ paths: properties: url: type: string - description: The URL for the [Get Fees](/docs/rest-management/orders/order-fees#get-fees) enpoint, preconfigured with your store hash and order ID. + description: The URL for the [Get Fees](/docs/rest-management/orders/order-fees#get-fees) endpoint, preconfigured with your store hash and order ID. example: "https://api-b2b.bigcommerce.com/stores/{store_hash}/v3/orders/123/fees" minLength: 1 resource: @@ -810,7 +810,7 @@ paths: type: string description: The price of the quantity of products before any discounts. example: "49.50" - total_ex_tax: + total_ex_tax: type: string description: The total price of the quantity of products, excluding tax. example: "49.50" @@ -978,7 +978,7 @@ paths: example: "Spring Sale" code: type: string - description: The coupon code. If the dicsount is not a coupon, then the field's value is `null`. + description: The coupon code. If the discount is not a coupon, then the field's value is `null`. example: "CPN123" target: type: string @@ -997,7 +997,7 @@ paths: $ref: '#/components/schemas/product_options' configurable_fields: type: array - description: Contains information on deprecated product configurable fields, if available. + description: Contains information on deprecated product configurable fields, if available. items: type: object properties: @@ -1085,7 +1085,7 @@ paths: properties: url: type: string - description: The URL for the List Order Coupons enpoint, preconfigured with your store hash and order ID. + description: The URL for the List Order Coupons endpoint, preconfigured with your store hash and order ID. example: "https://api.bigcommerce.com/stores/1234acd/v2/orders/123/coupons" resource: type: string @@ -1100,11 +1100,11 @@ paths: example: "12345" tax_provider_id: type: string - description: Indicate which tax provider was used for the order. If the order wass created with the API, or the tax provider is unknown, the field's value is blank. + description: Indicate which tax provider was used for the order. If the order was created with the API, or the tax provider is unknown, the field's value is blank. example: "AvalaraProvider" customer_locale: type: string - description: The custoemr's locale. + description: The customer's locale. example: "en" external_order_id: type: string @@ -1172,7 +1172,7 @@ paths: type: string description: The full name of the state or province on the shipping address. example: "Texas" - email: + email: type: string description: The email address associated with the shipping address. example: "mcurie@greatbuysinc.com" @@ -1224,7 +1224,7 @@ paths: properties: url: type: string - description: The URL for the [Get Order Shipping Quotes](/docs/rest-management/orders/order-shipping-addresses-quotes#get-order-shipping-quotes) enpoint, preconfigured with your store hash and order ID. + description: The URL for the [Get Order Shipping Quotes](/docs/rest-management/orders/order-shipping-addresses-quotes#get-order-shipping-quotes) endpoint, preconfigured with your store hash and order ID. example: "https://api.bigcommerce.com/stores/1234acd/v2/orders/123/shipping_addresses/185/shipping_quotes" resource: type: string @@ -1879,7 +1879,7 @@ components: example: 12345 nullable: true readOnly: true - extraInt3: + extraInt3: type: integer description: A legacy integer extra field configuration that does not return data in newer stores. example: 12345 @@ -2217,7 +2217,7 @@ components: type: string description: The full name of the state or province on the shipping address. example: "Texas" - email: + email: type: string description: The email address associated with the shipping address. example: "mcurie@greatbuysinc.com" diff --git a/docs/b2b-edition/specs/storefront/storefront/rfq.yaml b/docs/b2b-edition/specs/storefront/storefront/rfq.yaml index 6360322a5..2bab70074 100644 --- a/docs/b2b-edition/specs/storefront/storefront/rfq.yaml +++ b/docs/b2b-edition/specs/storefront/storefront/rfq.yaml @@ -298,7 +298,7 @@ paths: referenceNumber: "04292025-0001" userEmail: "mcurie@greatbuysinc.com" quoteTitle: "Plants Bulk Request" - shippingAddress: + shippingAddress: city: "Austin" state: "Texas" address: "512 Bluebonnet Lane" @@ -345,7 +345,7 @@ paths: isBackendUser: 1 bcCustomerId: 123 channelId: 1 - + responses: "200": description: OK @@ -590,7 +590,7 @@ paths: description: |- Generates a download link to a PDF copy of the specified quote. The PDF uses the default template configured in the store's Quote settings. - You can opionally include the `currency` array in the request body to convert prices in the PDF to a specific currency. Currency details can be fetched with the [Get All Available Currencies](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/store#get-all-available-currencies) endpoint. + You can optionally include the `currency` array in the request body to convert prices in the PDF to a specific currency. Currency details can be fetched with the [Get All Available Currencies](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/store#get-all-available-currencies) endpoint. Equivalent Storefront GraphQL API Mutation: `quoteFrontendPdf`. requestBody: @@ -647,7 +647,7 @@ paths: | quote_sales_rep_visibility | Indicates whether Sales Staff users are restricted to viewing quotes from their assigned Companies. This is enabled by default, and cannot be disabled. | | quote_sales_rep_creation | Indicates whether the built-in Sales Rep system user role is authorized to create quotes in the B2B Edition control panel. This configuration cannot be disabled, but you can create a custom user role for Sales Staff without quote permissions. | | email_quote_for_merchant | Indicates whether the New quote email template for merchants is enabled in the store's Email settings | - | quote_logo | The URL for the logo image in the store's General setings, which appears on quote emails and PDFs | + | quote_logo | The URL for the logo image in the store's General settings, which appears on quote emails and PDFs | | quote_cost_column | Indicates whether the store's Quotes settings are configured to display the product cost column in the line items table while viewing a quote in the B2B Edition control panel | | quote_margin_column | Indicates whether the store's Quotes settings are configured to display the cost margin column in the line items table while viewing a quote in the B2B Edition control panel | | customer_update_quote_message_email_sales_rep | Indicates whether Sales Staff users are notified via email when a buyer from an assigned Company has created a quote. This is configured during initial setup. | @@ -686,7 +686,7 @@ paths: - "0 (Disabled)" - "1 (Enabled)" example: "1" - description: "Indicates whether or not a quote configuration is enabled in the store. For the `quote_logo` config, the enabled value is the logo image URL insstead of `1`." + description: "Indicates whether or not a quote configuration is enabled in the store. For the `quote_logo` config, the enabled value is the logo image URL instead of `1`." quoteOtherConfigs: type: array description: "Contains information about quotes settings with configurable text or number values." @@ -858,7 +858,7 @@ paths: description: |- Retrieves basic information about the store, Company, sales rep, and extra field information. This is used in the storefront to provide basic information on a quote’s detail page, such as the quote logo and Sales Staff user details. - The `companyId` and `salesRepId` parameters must be included in the query in order to return Company and sales rep information respectively. If omitted, the response still contains store and extra field information. + The `companyId` and `salesRepId` parameters must be included in the query in order to return Company and sales rep information respectively. If omitted, the response still contains store and extra field information. parameters: - $ref: "#/components/parameters/storeHash" - name: companyId @@ -1217,7 +1217,7 @@ components: - "digital" example: "physical" description: "Indicates whether the line item is a physical or digital product." - isFreeShippig: + isFreeShipping: type: boolean example: true description: "Indicates whether the line item has product-level free shipping." @@ -1348,7 +1348,7 @@ components: discount: type: number example: "10" - description: "The discount percentage applied to the line item." + description: "The discount percentage applied to the line item." offeredPrice: type: number example: "22.50" @@ -1642,7 +1642,7 @@ components: type: string example: "512 Bluebonnet Lane" description: "The first line of the primary address for the Company account." - copmanyCountry: + companyCountry: type: string example: "United States" description: "The full name of the country on the primary address of the Company account." @@ -1737,7 +1737,7 @@ components: type: integer example: "100" description: "The maximum character length of the value entered for the extra field. This only applies to extra fields with a `fieldType` of `0` (text)." - nubmerOfRows: + numberOfRows: type: integer example: "10" description: "The maximum number or text rows for the value entered for the extra field. This only applies to extra fields with a `fieldType` of `1` (multi-line text)." @@ -1756,7 +1756,7 @@ components: maximumLimit: type: integer example: "10" - description: "The maxmimum number of characters of the maximum number of rows, depending on the field type." + description: "The maximum number of characters of the maximum number of rows, depending on the field type." quoteLogo: type: string example: "https://s3-us-west-2.amazonaws.com/bundleb2b-v3.0-media-files-prod/quote-logo.png" diff --git a/docs/storefront/graphql/b2b/company-account-registration.mdx b/docs/storefront/graphql/b2b/company-account-registration.mdx index 9661490ba..f13c083a3 100644 --- a/docs/storefront/graphql/b2b/company-account-registration.mdx +++ b/docs/storefront/graphql/b2b/company-account-registration.mdx @@ -8,7 +8,7 @@ However, BigCommerce's GraphQL Storefront API includes the `registerCompany` mut The `registerCompany` mutation accepts Company information like name, primary address, and custom fields configured in the B2B Edition control panel. If you've created extra fields for Company user records, it also allows current B2C customers to supply that information while requesting a B2B account. Upon success, this generates a new Company account in either the **Pending** or **Active** status, depending on your store's Company management configurations. See the "General Settings" section of [B2B Edition Settings](https://support.bigcommerce.com/s/article/B2B-Edition-Settings) in the Help Center for more information. -The mutation also passes the `customer_id` and `channel_id` of the current sesion in order to generate a Company user account for the customer and set the corresponding storefront as the user's origin channel. +The mutation also passes the `customer_id` and `channel_id` of the current session in order to generate a Company user account for the customer and set the corresponding storefront as the user's origin channel. ## Tokens @@ -61,7 +61,7 @@ mutation { phone: "5121234567", postalCode: "78704" # Address extra fields - extraFields: { + extraFields: { texts: [ { name: "Text Field Name", text: "Text Value" } ], @@ -77,7 +77,7 @@ mutation { } }, # Company account extra fields - extraFields: { + extraFields: { texts: [ { name: "Text Field Name", text: "Text Value" } ], @@ -92,7 +92,7 @@ mutation { ] }, # Company user extra fields - companyUser: { + companyUser: { extraFields: { texts: [ { name: "Text Field Name", text: "Text Value" }