From 8918453656fe208d109af4295892dfc5174cdf76 Mon Sep 17 00:00:00 2001 From: Chris Nowicki Date: Tue, 4 Nov 2025 16:36:37 -0500 Subject: [PATCH 1/2] add customerId to get super admin details response --- .../specs/api-v3/super_admin/super_admin.yaml | 318 +++++++++--------- 1 file changed, 161 insertions(+), 157 deletions(-) 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 ff935dc38..ea237e7bc 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 @@ -24,7 +24,7 @@ security: - X-Auth-Token: [] X-Store-Hash: [] tags: - - name: Super Admin + - name: Super Admin paths: /super-admins: @@ -36,7 +36,7 @@ paths: > **NOTE** > If there is already a B2B Edition Company user account associated with the email address provided, this endpoint will return a 400 error, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw the error as long as they are not also B2B Edition Company user accounts. - If a user account for the provided `email` doesn't currently exist within BigCommerce, it will be created when the request is called. + If a user account for the provided `email` doesn't currently exist within BigCommerce, it will be created when the request is called. operationId: post-super-admins tags: [Super Admin] requestBody: @@ -48,54 +48,54 @@ paths: - lastName - email allOf: - - $ref: "#/components/schemas/superAdminCore" + - $ref: '#/components/schemas/superAdminCore' - properties: originChannelId: - $ref: "#/components/schemas/superAdminOrigin" + $ref: '#/components/schemas/superAdminOrigin' channelIds: - $ref: "#/components/schemas/superAdminChannelIds" + $ref: '#/components/schemas/superAdminChannelIds' extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' data: properties: userId: - $ref: "#/components/schemas/superAdminId" + $ref: '#/components/schemas/superAdminId' customerId: type: integer - description: "The unique Customer ID assigned to the BigCommerce customer account. Can be used with core BigCommerce API endpoints (see [Customers](/docs/rest-management/customers) or [Customers-v2](/docs/rest-management/customers-v2) for more information). Does **not** match `userId`." + description: 'The unique Customer ID assigned to the BigCommerce customer account. Can be used with core BigCommerce API endpoints (see [Customers](/docs/rest-management/customers) or [Customers-v2](/docs/rest-management/customers-v2) for more information). Does **not** match `userId`.' example: 100 '400': description: |- BAD REQUEST. - + This response indicates that the body of the request was invalid in some way. The most common cause is that a B2B Edition user account exists for the provided email address already. See `meta.message` for more information. content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 400 meta: properties: message: - default: "The user already exists." + default: 'The user already exists.' /super-admins/bulk: post: @@ -108,7 +108,7 @@ paths: > **NOTE** > If there is already a B2B Edition Company user account associated with an email address provided, this endpoint will return with errors, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw errors as long as they are not also B2B Edition Company user accounts. - If a user account for a given `email` doesn't currently exist within BigCommerce, it will be created when the request is called. + If a user account for a given `email` doesn't currently exist within BigCommerce, it will be created when the request is called. operationId: post-super-admins-bulk tags: [Super Admin] requestBody: @@ -122,68 +122,68 @@ paths: - lastName - email allOf: - - $ref: "#/components/schemas/superAdminCore" + - $ref: '#/components/schemas/superAdminCore' - properties: originChannelId: - $ref: "#/components/schemas/superAdminOrigin" + $ref: '#/components/schemas/superAdminOrigin' channelIds: - $ref: "#/components/schemas/superAdminChannelIds" + $ref: '#/components/schemas/superAdminChannelIds' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' data: properties: superAdminIds: type: array - description: "An array of unique user IDs used to reference Super Admins via API." + description: 'An array of unique user IDs used to reference Super Admins via API.' items: - $ref: "#/components/schemas/superAdminId" + $ref: '#/components/schemas/superAdminId' '400': - description: "BAD REQUEST" + description: 'BAD REQUEST' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 400 meta: properties: message: - default: "API logic error" + default: 'API logic error' data: type: object properties: errMsg: type: string - default: "The super admin already exists" + default: 'The super admin already exists' '413': - description: "REQUEST TOO LARGE" + description: 'REQUEST TOO LARGE' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 413 meta: properties: message: - default: "Request Entity Too Large" + default: 'Request Entity Too Large' '422': description: |- INVALID REQUEST @@ -193,14 +193,14 @@ paths: application/json: schema: allOf: - - $ref: "#/components/schemas/responseArray" + - $ref: '#/components/schemas/responseArray' - properties: code: default: 422 meta: properties: message: - default: "Parameter Error" + default: 'Parameter Error' data: description: |- An array of objects containing field names with errors and corresponding messages for those errors. @@ -215,17 +215,17 @@ paths: type: array items: type: string - default: "This field is required" + default: 'This field is required' lastName: type: array items: type: string - default: "This field is required" + default: 'This field is required' email: type: array items: type: string - default: "This field is required" + default: 'This field is required' /super-admins/companies: get: @@ -240,60 +240,60 @@ paths: - $ref: '#/components/parameters/orderBy' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseArray" + - $ref: '#/components/schemas/responseArray' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' pagination: - $ref: "#/components/schemas/paginationObject" + $ref: '#/components/schemas/paginationObject' data: items: allOf: - - $ref: "#/components/schemas/companyCore" + - $ref: '#/components/schemas/companyCore' - properties: description: type: string - description: "The name of the business associated with the Company account." - example: "Great Buys" + description: 'The name of the business associated with the Company account.' + example: 'Great Buys' addressLine1: type: string maxLength: 200 - description: "The first line of the primary address for the Company account." - example: "123 Main Street" + description: 'The first line of the primary address for the Company account.' + example: '123 Main Street' addressLine2: type: string maxLength: 200 - description: "The second line of the primary address for the Company account." - example: "Building 100" + description: 'The second line of the primary address for the Company account.' + example: 'Building 100' city: type: string maxLength: 100 - description: "The city of the primary address for the Company account." - example: "Austin" + description: 'The city of the primary address for the Company account.' + example: 'Austin' state: type: string maxLength: 50 - description: "The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation." - example: "Texas" + description: 'The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation.' + example: 'Texas' country: type: string maxLength: 200 - description: "The country of the primary address for the Company account. This must be either the full name or the ISO2 country code." - example: "`United States` or `US`" + description: 'The country of the primary address for the Company account. This must be either the full name or the ISO2 country code.' + example: '`United States` or `US`' zipCode: type: string maxLength: 50 - description: "The postal code of the primary address for the Company account." - example: "78726" + description: 'The postal code of the primary address for the Company account.' + example: '78726' catalogId: type: string nullable: true @@ -302,7 +302,7 @@ paths: example: null superAdminCount: type: integer - description: "The number of Super Admin accounts assigned to this Company." + description: 'The number of Super Admin accounts assigned to this Company.' example: 1 /super-admins/{superAdminId}: @@ -310,7 +310,7 @@ paths: - $ref: '#/components/parameters/superAdminId' put: summary: Update Super Admin Company Assignments - description: "Assigns or unassigns Companies for the Super Admin associated with `superAdminId`. This operation is non-destructive, meaning that only Companies represented in the request body will be affected by the request." + description: 'Assigns or unassigns Companies for the Super Admin associated with `superAdminId`. This operation is non-destructive, meaning that only Companies represented in the request body will be affected by the request.' operationId: put-super-admins-superAdminId tags: [Super Admin] requestBody: @@ -330,24 +330,24 @@ paths: type: object properties: companyId: - $ref: "#/components/schemas/companyId" + $ref: '#/components/schemas/companyId' isAssigned: - $ref: "#/components/schemas/isAssigned" + $ref: '#/components/schemas/isAssigned' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' '404': $ref: '#/components/responses/404' @@ -356,7 +356,7 @@ paths: - $ref: '#/components/parameters/superAdminId' get: summary: Get A Super Admin's Assigned Companies - description: "Lists all Companies assigned to the Super Admin account associated with `superAdminId`. The response will contain limited information about each Company, but more information is available through the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information)." + description: 'Lists all Companies assigned to the Super Admin account associated with `superAdminId`. The response will contain limited information about each Company, but more information is available through the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information).' operationId: get-super-admins-superAdminId-companies tags: [Super Admin] parameters: @@ -364,24 +364,24 @@ paths: - $ref: '#/components/parameters/offset' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseArray" + - $ref: '#/components/schemas/responseArray' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' pagination: - $ref: "#/components/schemas/paginationObject" + $ref: '#/components/schemas/paginationObject' data: items: - $ref: "#/components/schemas/companyCore" + $ref: '#/components/schemas/companyCore' '404': $ref: '#/components/responses/404' @@ -390,30 +390,34 @@ paths: - $ref: '#/components/parameters/superAdminId' get: summary: Get Super Admin Details - description: "Returns detailed information about the Super Admin account associated with `superAdminId`." + description: 'Returns detailed information about the Super Admin account associated with `superAdminId`.' operationId: get-super-admins-info-superAdminId tags: [Super Admin] responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' data: allOf: - - $ref: "#/components/schemas/superAdminResponse" + - $ref: '#/components/schemas/superAdminResponse' - properties: + customerId: + type: integer + description: 'Customer ID of the Super Admin account.' + example: 343 extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' '404': $ref: '#/components/responses/404' @@ -421,7 +425,7 @@ paths: summary: Update Super Admin Details description: |- Updates the account information of the Super Admin associated with `superAdminId`. - + > **NOTE** > A BigCommerce customer account and a B2B Edition user account are both uniquely identified by their email address. As such, the `email` field is considered read-only. Updating the email address should be avoided, but may be done with the [Update Customers](/docs/rest-management/customers#update-customers) endpoint. operationId: put-super-admins-info-superAdminId @@ -431,33 +435,33 @@ paths: application/json: schema: allOf: - - $ref: "#/components/schemas/superAdminBase" + - $ref: '#/components/schemas/superAdminBase' - properties: channelIds: - $ref: "#/components/schemas/superAdminChannelIds" + $ref: '#/components/schemas/superAdminChannelIds' extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' data: allOf: - - $ref: "#/components/schemas/superAdminResponse" + - $ref: '#/components/schemas/superAdminResponse' - properties: extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' '404': $ref: '#/components/responses/404' @@ -477,57 +481,57 @@ paths: in: query schema: type: string - example: "b2b-uuid-1" - description: "Filter results by `uuid`. An empty `uuid` parameter will return all results." + example: 'b2b-uuid-1' + description: 'Filter results by `uuid`. An empty `uuid` parameter will return all results.' - name: maxCreated in: query schema: type: string - example: "1745868780" - description: "Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`." + example: '1745868780' + description: 'Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`.' - name: minCreated in: query schema: type: string - example: "1745868780" - description: "Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`." + example: '1745868780' + description: 'Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`.' - name: maxModified in: query schema: type: string - example: "1745868780" - description: "Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`." + example: '1745868780' + description: 'Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`.' - name: minModified in: query schema: type: string - example: "1745868780" - description: "Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minModified`." + example: '1745868780' + description: 'Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minModified`.' - $ref: '#/components/parameters/extraFields' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseArray" + - $ref: '#/components/schemas/responseArray' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' pagination: - $ref: "#/components/schemas/paginationObject" + $ref: '#/components/schemas/paginationObject' data: items: allOf: - - $ref: "#/components/schemas/superAdminResponse" + - $ref: '#/components/schemas/superAdminResponse' - properties: extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' /companies/{companyId}/super-admins: parameters: @@ -545,34 +549,34 @@ paths: - $ref: '#/components/parameters/extraFields' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseArray" + - $ref: '#/components/schemas/responseArray' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' pagination: - $ref: "#/components/schemas/paginationObject" + $ref: '#/components/schemas/paginationObject' data: items: allOf: - - $ref: "#/components/schemas/superAdminResponse" + - $ref: '#/components/schemas/superAdminResponse' - properties: extraFields: - $ref: "#/components/schemas/extraFieldsArray" + $ref: '#/components/schemas/extraFieldsArray' '404': $ref: '#/components/responses/404' put: summary: Update Company Super Admins Assignments - description: "Assigns or unassigns Super Admins for the Company associated with `companyId`. This operation is non-destructive, meaning that only Super Admins represented in the request body will be affected by the request." + description: 'Assigns or unassigns Super Admins for the Company associated with `companyId`. This operation is non-destructive, meaning that only Super Admins represented in the request body will be affected by the request.' operationId: put-companies-companyId-super-admins tags: [Super Admin] requestBody: @@ -592,24 +596,24 @@ paths: type: object properties: superAdminId: - $ref: "#/components/schemas/superAdminId" + $ref: '#/components/schemas/superAdminId' isAssigned: - $ref: "#/components/schemas/isAssigned" + $ref: '#/components/schemas/isAssigned' responses: '200': - description: "SUCCESS" + description: 'SUCCESS' content: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 200 meta: properties: message: - default: "Success" + default: 'Success' '404': $ref: '#/components/responses/404' @@ -634,13 +638,13 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | - + ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header @@ -652,15 +656,15 @@ components: properties: fieldName: type: string - description: "The name of the custom field" - example: "customField1" + description: 'The name of the custom field' + example: 'customField1' fieldValue: type: string - description: "Value for the custom field." - example: "foo" + description: 'Value for the custom field.' + example: 'foo' isAssigned: type: boolean - description: "Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned." + description: 'Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned.' companyId: type: integer description: |- @@ -670,68 +674,68 @@ components: type: object properties: companyId: - $ref: "#/components/schemas/companyId" + $ref: '#/components/schemas/companyId' companyName: type: string maxLength: 200 - description: "The name of the business associated with the Company account." - example: "Great Buys Inc." + description: 'The name of the business associated with the Company account.' + example: 'Great Buys Inc.' companyEmail: type: string format: email - description: "The primary email address for the Company account." - example: "admin@greatbuys.com" + description: 'The primary email address for the Company account.' + example: 'admin@greatbuys.com' superAdminBase: type: object properties: firstName: type: string description: "The first name listed on the Super Admin's BigCommerce customer account." - example: "Marie" + example: 'Marie' lastName: type: string description: "The last name listed on the Super Admin's BigCommerce customer account." - example: "Curie" + example: 'Curie' phone: type: string description: "The phone number listed on the Super Admin's BigCommerce customer account." - example: "string" + example: 'string' uuid: type: string format: uuid description: |- An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default. - + > NOTE > Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details. > > Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field. superAdminCore: allOf: - - $ref: "#/components/schemas/superAdminBase" + - $ref: '#/components/schemas/superAdminBase' - properties: email: type: string format: email description: "The email address associated with the Super Admin's BigCommerce customer account." - example: "marie.curie@example.com" + example: 'marie.curie@example.com' superAdminResponse: allOf: - properties: id: - $ref: "#/components/schemas/superAdminId" - - $ref: "#/components/schemas/superAdminCore" + $ref: '#/components/schemas/superAdminId' + - $ref: '#/components/schemas/superAdminCore' - properties: createdAt: type: integer - description: "The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was created." + description: 'The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was created.' example: 1745868780 updatedAt: type: integer - description: "The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was last modified." + description: 'The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was last modified.' example: 1750962754 channelList: - $ref: "#/components/schemas/superAdminChannels" + $ref: '#/components/schemas/superAdminChannels' superAdminChannels: type: array items: @@ -739,25 +743,25 @@ components: properties: channelId: type: integer - description: "The unique channel ID associated with the BigCommerce sales channel." + description: 'The unique channel ID associated with the BigCommerce sales channel.' example: 1 channelName: type: string - description: "The name associated with the BigCommerce sales channel." - example: "Great Buys Wholesale" + description: 'The name associated with the BigCommerce sales channel.' + example: 'Great Buys Wholesale' iconUrl: type: string description: "The specific icon associated with the BigCommerce sales channel's type." - example: "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg" + example: 'https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg' superAdminChannelIds: type: array - description: "An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list." + description: 'An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list.' items: type: integer example: 1 superAdminId: type: integer - description: "The unique user ID assigned by B2B Edition and used to reference a Super Admin via API." + description: 'The unique user ID assigned by B2B Edition and used to reference a Super Admin via API.' example: 123456 superAdminOrigin: type: integer @@ -768,15 +772,15 @@ components: properties: offset: type: integer - description: "The number of entries skipped before the results returned." + description: 'The number of entries skipped before the results returned.' default: 0 limit: type: integer - description: "The maximum number of entries allowed to return with the request. This may be greater than the actual number of returned entries." + description: 'The maximum number of entries allowed to return with the request. This may be greater than the actual number of returned entries.' default: 10 totalCount: type: integer - description: "The total number of entries in the dataset." + description: 'The total number of entries in the dataset.' example: 789 responseObject: type: object @@ -810,16 +814,16 @@ components: in: query schema: type: string - default: "0" - enum: ["0", "1"] - description: "Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them." + default: '0' + enum: ['0', '1'] + description: 'Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them.' queryString: name: q in: query schema: type: string - example: "alice" - description: "Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`." + example: 'alice' + description: 'Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`.' companyId: name: companyId in: path @@ -827,7 +831,7 @@ components: schema: type: integer example: 14 - description: "The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information)." + description: 'The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information).' limit: name: limit in: query @@ -837,7 +841,7 @@ components: default: 10 maximum: 200 minimum: 1 - description: "Maximum number of entries to return per page of results." + description: 'Maximum number of entries to return per page of results.' offset: name: offset in: query @@ -845,7 +849,7 @@ components: type: integer default: 0 minimum: 0 - description: "The number of entries to skip before returning the current page of results." + description: 'The number of entries to skip before returning the current page of results.' superAdminId: name: superAdminId in: path @@ -853,16 +857,16 @@ components: schema: type: integer example: 11 - description: "The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID." + description: 'The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.' orderBy: name: orderBy in: query required: false schema: type: string - enum: ["DESC","ASC"] - default: "DESC" - description: "Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order." + enum: ['DESC', 'ASC'] + default: 'DESC' + description: 'Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order.' responses: '404': description: NOT FOUND @@ -870,11 +874,11 @@ components: application/json: schema: allOf: - - $ref: "#/components/schemas/responseObject" + - $ref: '#/components/schemas/responseObject' - properties: code: default: 404 meta: properties: message: - default: "The ID provided does not match an available resource of the appropriate type." + default: 'The ID provided does not match an available resource of the appropriate type.' From cb4b9f67182e6736eaeb831bd5f99f3aabe4f448 Mon Sep 17 00:00:00 2001 From: Chris Nowicki Date: Tue, 4 Nov 2025 16:40:47 -0500 Subject: [PATCH 2/2] fix formatting --- .../specs/api-v3/super_admin/super_admin.yaml | 314 +++++++++--------- 1 file changed, 157 insertions(+), 157 deletions(-) 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 ea237e7bc..62aa74a88 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 @@ -24,7 +24,7 @@ security: - X-Auth-Token: [] X-Store-Hash: [] tags: - - name: Super Admin + - name: Super Admin paths: /super-admins: @@ -36,7 +36,7 @@ paths: > **NOTE** > If there is already a B2B Edition Company user account associated with the email address provided, this endpoint will return a 400 error, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw the error as long as they are not also B2B Edition Company user accounts. - If a user account for the provided `email` doesn't currently exist within BigCommerce, it will be created when the request is called. + If a user account for the provided `email` doesn't currently exist within BigCommerce, it will be created when the request is called. operationId: post-super-admins tags: [Super Admin] requestBody: @@ -48,54 +48,54 @@ paths: - lastName - email allOf: - - $ref: '#/components/schemas/superAdminCore' + - $ref: "#/components/schemas/superAdminCore" - properties: originChannelId: - $ref: '#/components/schemas/superAdminOrigin' + $ref: "#/components/schemas/superAdminOrigin" channelIds: - $ref: '#/components/schemas/superAdminChannelIds' + $ref: "#/components/schemas/superAdminChannelIds" extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" data: properties: userId: - $ref: '#/components/schemas/superAdminId' + $ref: "#/components/schemas/superAdminId" customerId: type: integer - description: 'The unique Customer ID assigned to the BigCommerce customer account. Can be used with core BigCommerce API endpoints (see [Customers](/docs/rest-management/customers) or [Customers-v2](/docs/rest-management/customers-v2) for more information). Does **not** match `userId`.' + description: "The unique Customer ID assigned to the BigCommerce customer account. Can be used with core BigCommerce API endpoints (see [Customers](/docs/rest-management/customers) or [Customers-v2](/docs/rest-management/customers-v2) for more information). Does **not** match `userId`." example: 100 '400': description: |- BAD REQUEST. - + This response indicates that the body of the request was invalid in some way. The most common cause is that a B2B Edition user account exists for the provided email address already. See `meta.message` for more information. content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 400 meta: properties: message: - default: 'The user already exists.' + default: "The user already exists." /super-admins/bulk: post: @@ -108,7 +108,7 @@ paths: > **NOTE** > If there is already a B2B Edition Company user account associated with an email address provided, this endpoint will return with errors, regardless of the role assigned to the B2B Edition Company user account. Existing BigCommerce customer accounts will not throw errors as long as they are not also B2B Edition Company user accounts. - If a user account for a given `email` doesn't currently exist within BigCommerce, it will be created when the request is called. + If a user account for a given `email` doesn't currently exist within BigCommerce, it will be created when the request is called. operationId: post-super-admins-bulk tags: [Super Admin] requestBody: @@ -122,68 +122,68 @@ paths: - lastName - email allOf: - - $ref: '#/components/schemas/superAdminCore' + - $ref: "#/components/schemas/superAdminCore" - properties: originChannelId: - $ref: '#/components/schemas/superAdminOrigin' + $ref: "#/components/schemas/superAdminOrigin" channelIds: - $ref: '#/components/schemas/superAdminChannelIds' + $ref: "#/components/schemas/superAdminChannelIds" responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" data: properties: superAdminIds: type: array - description: 'An array of unique user IDs used to reference Super Admins via API.' + description: "An array of unique user IDs used to reference Super Admins via API." items: - $ref: '#/components/schemas/superAdminId' + $ref: "#/components/schemas/superAdminId" '400': - description: 'BAD REQUEST' + description: "BAD REQUEST" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 400 meta: properties: message: - default: 'API logic error' + default: "API logic error" data: type: object properties: errMsg: type: string - default: 'The super admin already exists' + default: "The super admin already exists" '413': - description: 'REQUEST TOO LARGE' + description: "REQUEST TOO LARGE" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 413 meta: properties: message: - default: 'Request Entity Too Large' + default: "Request Entity Too Large" '422': description: |- INVALID REQUEST @@ -193,14 +193,14 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/responseArray' + - $ref: "#/components/schemas/responseArray" - properties: code: default: 422 meta: properties: message: - default: 'Parameter Error' + default: "Parameter Error" data: description: |- An array of objects containing field names with errors and corresponding messages for those errors. @@ -215,17 +215,17 @@ paths: type: array items: type: string - default: 'This field is required' + default: "This field is required" lastName: type: array items: type: string - default: 'This field is required' + default: "This field is required" email: type: array items: type: string - default: 'This field is required' + default: "This field is required" /super-admins/companies: get: @@ -240,60 +240,60 @@ paths: - $ref: '#/components/parameters/orderBy' responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseArray' + - $ref: "#/components/schemas/responseArray" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" pagination: - $ref: '#/components/schemas/paginationObject' + $ref: "#/components/schemas/paginationObject" data: items: allOf: - - $ref: '#/components/schemas/companyCore' + - $ref: "#/components/schemas/companyCore" - properties: description: type: string - description: 'The name of the business associated with the Company account.' - example: 'Great Buys' + description: "The name of the business associated with the Company account." + example: "Great Buys" addressLine1: type: string maxLength: 200 - description: 'The first line of the primary address for the Company account.' - example: '123 Main Street' + description: "The first line of the primary address for the Company account." + example: "123 Main Street" addressLine2: type: string maxLength: 200 - description: 'The second line of the primary address for the Company account.' - example: 'Building 100' + description: "The second line of the primary address for the Company account." + example: "Building 100" city: type: string maxLength: 100 - description: 'The city of the primary address for the Company account.' - example: 'Austin' + description: "The city of the primary address for the Company account." + example: "Austin" state: type: string maxLength: 50 - description: 'The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation.' - example: 'Texas' + description: "The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation." + example: "Texas" country: type: string maxLength: 200 - description: 'The country of the primary address for the Company account. This must be either the full name or the ISO2 country code.' - example: '`United States` or `US`' + description: "The country of the primary address for the Company account. This must be either the full name or the ISO2 country code." + example: "`United States` or `US`" zipCode: type: string maxLength: 50 - description: 'The postal code of the primary address for the Company account.' - example: '78726' + description: "The postal code of the primary address for the Company account." + example: "78726" catalogId: type: string nullable: true @@ -302,7 +302,7 @@ paths: example: null superAdminCount: type: integer - description: 'The number of Super Admin accounts assigned to this Company.' + description: "The number of Super Admin accounts assigned to this Company." example: 1 /super-admins/{superAdminId}: @@ -310,7 +310,7 @@ paths: - $ref: '#/components/parameters/superAdminId' put: summary: Update Super Admin Company Assignments - description: 'Assigns or unassigns Companies for the Super Admin associated with `superAdminId`. This operation is non-destructive, meaning that only Companies represented in the request body will be affected by the request.' + description: "Assigns or unassigns Companies for the Super Admin associated with `superAdminId`. This operation is non-destructive, meaning that only Companies represented in the request body will be affected by the request." operationId: put-super-admins-superAdminId tags: [Super Admin] requestBody: @@ -330,24 +330,24 @@ paths: type: object properties: companyId: - $ref: '#/components/schemas/companyId' + $ref: "#/components/schemas/companyId" isAssigned: - $ref: '#/components/schemas/isAssigned' + $ref: "#/components/schemas/isAssigned" responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" '404': $ref: '#/components/responses/404' @@ -356,7 +356,7 @@ paths: - $ref: '#/components/parameters/superAdminId' get: summary: Get A Super Admin's Assigned Companies - description: 'Lists all Companies assigned to the Super Admin account associated with `superAdminId`. The response will contain limited information about each Company, but more information is available through the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information).' + description: "Lists all Companies assigned to the Super Admin account associated with `superAdminId`. The response will contain limited information about each Company, but more information is available through the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information)." operationId: get-super-admins-superAdminId-companies tags: [Super Admin] parameters: @@ -364,24 +364,24 @@ paths: - $ref: '#/components/parameters/offset' responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseArray' + - $ref: "#/components/schemas/responseArray" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" pagination: - $ref: '#/components/schemas/paginationObject' + $ref: "#/components/schemas/paginationObject" data: items: - $ref: '#/components/schemas/companyCore' + $ref: "#/components/schemas/companyCore" '404': $ref: '#/components/responses/404' @@ -390,34 +390,34 @@ paths: - $ref: '#/components/parameters/superAdminId' get: summary: Get Super Admin Details - description: 'Returns detailed information about the Super Admin account associated with `superAdminId`.' + description: "Returns detailed information about the Super Admin account associated with `superAdminId`." operationId: get-super-admins-info-superAdminId tags: [Super Admin] responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" data: allOf: - - $ref: '#/components/schemas/superAdminResponse' + - $ref: "#/components/schemas/superAdminResponse" - properties: customerId: type: integer description: 'Customer ID of the Super Admin account.' example: 343 extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" '404': $ref: '#/components/responses/404' @@ -425,7 +425,7 @@ paths: summary: Update Super Admin Details description: |- Updates the account information of the Super Admin associated with `superAdminId`. - + > **NOTE** > A BigCommerce customer account and a B2B Edition user account are both uniquely identified by their email address. As such, the `email` field is considered read-only. Updating the email address should be avoided, but may be done with the [Update Customers](/docs/rest-management/customers#update-customers) endpoint. operationId: put-super-admins-info-superAdminId @@ -435,33 +435,33 @@ paths: application/json: schema: allOf: - - $ref: '#/components/schemas/superAdminBase' + - $ref: "#/components/schemas/superAdminBase" - properties: channelIds: - $ref: '#/components/schemas/superAdminChannelIds' + $ref: "#/components/schemas/superAdminChannelIds" extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" data: allOf: - - $ref: '#/components/schemas/superAdminResponse' + - $ref: "#/components/schemas/superAdminResponse" - properties: extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" '404': $ref: '#/components/responses/404' @@ -481,57 +481,57 @@ paths: in: query schema: type: string - example: 'b2b-uuid-1' - description: 'Filter results by `uuid`. An empty `uuid` parameter will return all results.' + example: "b2b-uuid-1" + description: "Filter results by `uuid`. An empty `uuid` parameter will return all results." - name: maxCreated in: query schema: type: string - example: '1745868780' - description: 'Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`.' + example: "1745868780" + description: "Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`." - name: minCreated in: query schema: type: string - example: '1745868780' - description: 'Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`.' + example: "1745868780" + description: "Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`." - name: maxModified in: query schema: type: string - example: '1745868780' - description: 'Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`.' + example: "1745868780" + description: "Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`." - name: minModified in: query schema: type: string - example: '1745868780' - description: 'Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minModified`.' + example: "1745868780" + description: "Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minModified`." - $ref: '#/components/parameters/extraFields' responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseArray' + - $ref: "#/components/schemas/responseArray" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" pagination: - $ref: '#/components/schemas/paginationObject' + $ref: "#/components/schemas/paginationObject" data: items: allOf: - - $ref: '#/components/schemas/superAdminResponse' + - $ref: "#/components/schemas/superAdminResponse" - properties: extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" /companies/{companyId}/super-admins: parameters: @@ -549,34 +549,34 @@ paths: - $ref: '#/components/parameters/extraFields' responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseArray' + - $ref: "#/components/schemas/responseArray" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" pagination: - $ref: '#/components/schemas/paginationObject' + $ref: "#/components/schemas/paginationObject" data: items: allOf: - - $ref: '#/components/schemas/superAdminResponse' + - $ref: "#/components/schemas/superAdminResponse" - properties: extraFields: - $ref: '#/components/schemas/extraFieldsArray' + $ref: "#/components/schemas/extraFieldsArray" '404': $ref: '#/components/responses/404' put: summary: Update Company Super Admins Assignments - description: 'Assigns or unassigns Super Admins for the Company associated with `companyId`. This operation is non-destructive, meaning that only Super Admins represented in the request body will be affected by the request.' + description: "Assigns or unassigns Super Admins for the Company associated with `companyId`. This operation is non-destructive, meaning that only Super Admins represented in the request body will be affected by the request." operationId: put-companies-companyId-super-admins tags: [Super Admin] requestBody: @@ -596,24 +596,24 @@ paths: type: object properties: superAdminId: - $ref: '#/components/schemas/superAdminId' + $ref: "#/components/schemas/superAdminId" isAssigned: - $ref: '#/components/schemas/isAssigned' + $ref: "#/components/schemas/isAssigned" responses: '200': - description: 'SUCCESS' + description: "SUCCESS" content: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 200 meta: properties: message: - default: 'Success' + default: "Success" '404': $ref: '#/components/responses/404' @@ -638,13 +638,13 @@ components: | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | - + ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). - + For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). - + For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes). type: apiKey in: header @@ -656,15 +656,15 @@ components: properties: fieldName: type: string - description: 'The name of the custom field' - example: 'customField1' + description: "The name of the custom field" + example: "customField1" fieldValue: type: string - description: 'Value for the custom field.' - example: 'foo' + description: "Value for the custom field." + example: "foo" isAssigned: type: boolean - description: 'Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned.' + description: "Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned." companyId: type: integer description: |- @@ -674,68 +674,68 @@ components: type: object properties: companyId: - $ref: '#/components/schemas/companyId' + $ref: "#/components/schemas/companyId" companyName: type: string maxLength: 200 - description: 'The name of the business associated with the Company account.' - example: 'Great Buys Inc.' + description: "The name of the business associated with the Company account." + example: "Great Buys Inc." companyEmail: type: string format: email - description: 'The primary email address for the Company account.' - example: 'admin@greatbuys.com' + description: "The primary email address for the Company account." + example: "admin@greatbuys.com" superAdminBase: type: object properties: firstName: type: string description: "The first name listed on the Super Admin's BigCommerce customer account." - example: 'Marie' + example: "Marie" lastName: type: string description: "The last name listed on the Super Admin's BigCommerce customer account." - example: 'Curie' + example: "Curie" phone: type: string description: "The phone number listed on the Super Admin's BigCommerce customer account." - example: 'string' + example: "string" uuid: type: string format: uuid description: |- An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default. - + > NOTE > Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details. > > Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field. superAdminCore: allOf: - - $ref: '#/components/schemas/superAdminBase' + - $ref: "#/components/schemas/superAdminBase" - properties: email: type: string format: email description: "The email address associated with the Super Admin's BigCommerce customer account." - example: 'marie.curie@example.com' + example: "marie.curie@example.com" superAdminResponse: allOf: - properties: id: - $ref: '#/components/schemas/superAdminId' - - $ref: '#/components/schemas/superAdminCore' + $ref: "#/components/schemas/superAdminId" + - $ref: "#/components/schemas/superAdminCore" - properties: createdAt: type: integer - description: 'The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was created.' + description: "The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was created." example: 1745868780 updatedAt: type: integer - description: 'The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was last modified.' + description: "The [Unix timestamp](https://www.unixtimestamp.com/) indicating when the account was last modified." example: 1750962754 channelList: - $ref: '#/components/schemas/superAdminChannels' + $ref: "#/components/schemas/superAdminChannels" superAdminChannels: type: array items: @@ -743,25 +743,25 @@ components: properties: channelId: type: integer - description: 'The unique channel ID associated with the BigCommerce sales channel.' + description: "The unique channel ID associated with the BigCommerce sales channel." example: 1 channelName: type: string - description: 'The name associated with the BigCommerce sales channel.' - example: 'Great Buys Wholesale' + description: "The name associated with the BigCommerce sales channel." + example: "Great Buys Wholesale" iconUrl: type: string description: "The specific icon associated with the BigCommerce sales channel's type." - example: 'https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg' + example: "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg" superAdminChannelIds: type: array - description: 'An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list.' + description: "An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list." items: type: integer example: 1 superAdminId: type: integer - description: 'The unique user ID assigned by B2B Edition and used to reference a Super Admin via API.' + description: "The unique user ID assigned by B2B Edition and used to reference a Super Admin via API." example: 123456 superAdminOrigin: type: integer @@ -772,15 +772,15 @@ components: properties: offset: type: integer - description: 'The number of entries skipped before the results returned.' + description: "The number of entries skipped before the results returned." default: 0 limit: type: integer - description: 'The maximum number of entries allowed to return with the request. This may be greater than the actual number of returned entries.' + description: "The maximum number of entries allowed to return with the request. This may be greater than the actual number of returned entries." default: 10 totalCount: type: integer - description: 'The total number of entries in the dataset.' + description: "The total number of entries in the dataset." example: 789 responseObject: type: object @@ -814,16 +814,16 @@ components: in: query schema: type: string - default: '0' - enum: ['0', '1'] - description: 'Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them.' + default: "0" + enum: ["0", "1"] + description: "Indicates whether to include extra fields in the response. A value of `0` will exclude extra fields, while a value of `1` will include them." queryString: name: q in: query schema: type: string - example: 'alice' - description: 'Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`.' + example: "alice" + description: "Search string for the request. Response data will be limited to accounts matching this string in `firstName`, `lastName`, or `email`." companyId: name: companyId in: path @@ -831,7 +831,7 @@ components: schema: type: integer example: 14 - description: 'The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information).' + description: "The unique ID of a Company. Can be used with the B2B Edition Companies API endpoints (see [Company Management](/b2b-edition/apis/rest-management/company) or [Companies and Users](/b2b-edition/apis/rest-storefront/company) for more information)." limit: name: limit in: query @@ -841,7 +841,7 @@ components: default: 10 maximum: 200 minimum: 1 - description: 'Maximum number of entries to return per page of results.' + description: "Maximum number of entries to return per page of results." offset: name: offset in: query @@ -849,7 +849,7 @@ components: type: integer default: 0 minimum: 0 - description: 'The number of entries to skip before returning the current page of results.' + description: "The number of entries to skip before returning the current page of results." superAdminId: name: superAdminId in: path @@ -857,16 +857,16 @@ components: schema: type: integer example: 11 - description: 'The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID.' + description: "The unique ID of the Super Admin account. Does **not** match the BigCommerce customer account ID." orderBy: name: orderBy in: query required: false schema: type: string - enum: ['DESC', 'ASC'] - default: 'DESC' - description: 'Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order.' + enum: ["DESC","ASC"] + default: "DESC" + description: "Determines whether results will be sorted in acending (`ASC`) or descending (`DESC`) order." responses: '404': description: NOT FOUND @@ -874,11 +874,11 @@ components: application/json: schema: allOf: - - $ref: '#/components/schemas/responseObject' + - $ref: "#/components/schemas/responseObject" - properties: code: default: 404 meta: properties: message: - default: 'The ID provided does not match an available resource of the appropriate type.' + default: "The ID provided does not match an available resource of the appropriate type."