diff --git a/docs/b2b-edition/specs/api-v3/address/address.yaml b/docs/b2b-edition/specs/api-v3/address/address.yaml index 951a9cda5..1729fe64c 100644 --- a/docs/b2b-edition/specs/api-v3/address/address.yaml +++ b/docs/b2b-edition/specs/api-v3/address/address.yaml @@ -22,10 +22,9 @@ tags: - name: Addresses security: - X-Auth-Token: [] + X-Store-Hash: [] paths: /countries: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get a Country tags: @@ -121,8 +120,6 @@ paths: meta: message: Resource not found /states: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get a State tags: @@ -395,8 +392,6 @@ paths: - code - data - meta - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: summary: Create a Company Address operationId: post-companies-companyId-addresses @@ -515,7 +510,6 @@ paths: message: "Parameter Error" '/addresses/{addressId}': parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: addressId @@ -652,8 +646,6 @@ paths: schema: $ref: '#/components/schemas/responseNotFound' /addresses/bulk: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: summary: Bulk Create Addresses operationId: post-addresses @@ -887,8 +879,6 @@ paths: meta: message: "Parameter Error" /addresses/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get Address Extra Field Configs tags: @@ -988,14 +978,6 @@ paths: - meta components: parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. limit: name: limit in: query @@ -1305,6 +1287,16 @@ components: - data - meta securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- diff --git a/docs/b2b-edition/specs/api-v3/channel/channel.yaml b/docs/b2b-edition/specs/api-v3/channel/channel.yaml index 3f18d9549..f755478d2 100644 --- a/docs/b2b-edition/specs/api-v3/channel/channel.yaml +++ b/docs/b2b-edition/specs/api-v3/channel/channel.yaml @@ -21,12 +21,11 @@ servers: - url: 'https://api-b2b.bigcommerce.com/api/v3/io' security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Channels paths: /channels: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: "Get all Channels" tags: @@ -72,7 +71,6 @@ paths: example: "Multi storefront is not enabled" /channels/{channel_id}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: channel_id in: path required: true @@ -137,15 +135,6 @@ paths: description: Error message. example: "Channel does not exist" components: - parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. schemas: Channel: type: object @@ -213,6 +202,16 @@ components: description: "The [Unix Timestap](https://www.unixtimestamp.com/) last update date for the channel." example: "1750437336" securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- diff --git a/docs/b2b-edition/specs/api-v3/company/company.yaml b/docs/b2b-edition/specs/api-v3/company/company.yaml index 9a05525a5..a5620700a 100644 --- a/docs/b2b-edition/specs/api-v3/company/company.yaml +++ b/docs/b2b-edition/specs/api-v3/company/company.yaml @@ -110,6 +110,7 @@ servers: - url: "https://api-b2b.bigcommerce.com/api/v3/io" security: - X-Auth-Token: [] + - X-Store-Hash: [] tags: - name: Companies - name: Company Roles and Permissions @@ -117,8 +118,6 @@ tags: paths: /companies: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Companies @@ -487,7 +486,6 @@ paths: x-codegen-request-body-name: body /companies/{companyId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -631,7 +629,6 @@ paths: message: This resource is not found. /customer-groups/{customerGroupId}/companies: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: customerGroupId in: path required: true @@ -777,8 +774,6 @@ paths: "404": $ref: "#/components/responses/ERROR_404_Data" /companies/bulk: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: tags: - Companies @@ -1064,7 +1059,6 @@ paths: x-codegen-request-body-name: body /companies/{companyId}/catalogs: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" put: tags: @@ -1090,7 +1084,6 @@ paths: description: "Not Allowed; occurs if the store is using Independent Companies behavior" /companies/{companyId}/status: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" put: tags: @@ -1118,8 +1111,6 @@ paths: "200": $ref: "#/components/responses/RESPONSE_200_UPDATE" /companies/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Companies @@ -1273,8 +1264,6 @@ paths: - Manufacturing x-internal: false /companies/permissions: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Company Roles and Permissions @@ -1379,7 +1368,6 @@ paths: x-internal: false /companies/permissions/{permissionId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: permissionId in: path required: true @@ -1458,8 +1446,6 @@ paths: $ref: "#/components/responses/RESPONSE_200_Base" x-internal: false /companies/roles: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Company Roles and Permissions @@ -1565,7 +1551,6 @@ paths: x-internal: false /companies/roles/{roleId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: roleId in: path required: true @@ -1661,7 +1646,6 @@ paths: x-internal: false /companies/{companyId}/attachments: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -1711,7 +1695,6 @@ paths: $ref: "#/components/responses/RESPONSE_200_ATTACHMENT" /companies/{companyId}/attachments/{attachmentId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" - name: attachmentId in: path @@ -1732,7 +1715,6 @@ paths: $ref: "#/components/responses/RESPONSE_200_Base" /companies/{companyId}/subsidiaries: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -1821,7 +1803,6 @@ paths: $ref: "#/components/responses/ERROR_404_Parameter" /companies/{companyId}/subsidiaries/{childCompanyId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" - name: childCompanyId in: path @@ -1868,7 +1849,6 @@ paths: "1": Invalid child company ID. /companies/{companyId}/parent: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" post: tags: @@ -1948,7 +1928,6 @@ paths: "1": The parent company has reached the maximum layer. /companies/{companyId}/hierarchy: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" - $ref: "#/components/parameters/paginationOffset" - $ref: "#/components/parameters/paginationLimit" @@ -2659,14 +2638,6 @@ components: meta: message: SUCCESS parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. paginationLimit: name: limit in: query @@ -2692,6 +2663,16 @@ components: description: Unique numeric ID of the Company account. example: 123456 securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- diff --git a/docs/b2b-edition/specs/api-v3/invoice-management.yaml b/docs/b2b-edition/specs/api-v3/invoice-management.yaml index be6c1e7d7..0fc5b7422 100644 --- a/docs/b2b-edition/specs/api-v3/invoice-management.yaml +++ b/docs/b2b-edition/specs/api-v3/invoice-management.yaml @@ -19,6 +19,7 @@ servers: - url: "https://api-b2b.bigcommerce.com/api/v3/io/ip" security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Invoice description: Invoice @@ -27,15 +28,6 @@ tags: - name: Receipt description: Receipt components: - parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. responses: "Invoice404": description: Example response @@ -269,6 +261,16 @@ components: message: Not Found Error schemas: {} securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- @@ -291,7 +293,6 @@ components: paths: "/invoices/{invoiceId}": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: invoiceId @@ -1392,8 +1393,6 @@ paths: message: Bad Requests Error tags: - Invoice - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get invoices operationId: get-invoices @@ -1625,7 +1624,6 @@ paths: /invoices/export: {} "/orders/{orderId}/invoices": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: orderId @@ -1697,7 +1695,6 @@ paths: parameters: [] "/invoices/{invoiceId}/download-pdf": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: invoiceId @@ -1768,15 +1765,12 @@ paths: - Invoice "/invoices/{invoiceId}/send-mail": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: invoiceId in: path required: true /invoices/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get invoice extra field configs tags: @@ -1804,8 +1798,6 @@ paths: - $ref: '../../specs/api-v3/user/user.yaml#/components/parameters/limit' /payments: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get Payments tags: @@ -2266,7 +2258,6 @@ paths: description: Query by BigCommerce Channel IDs. This parameter is not needed if you don't have multiple storefront channels. "/payments/{paymentId}": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: paymentId @@ -2602,7 +2593,6 @@ paths: parameters: [] "/payments/{paymentId}/operations": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: paymentId @@ -2744,7 +2734,6 @@ paths: description: "" "/payments/{paymentId}/processing-status": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: paymentId @@ -2813,7 +2802,6 @@ paths: - processingStatus "/payments/{paymentId}/transactions": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: paymentId @@ -3050,7 +3038,6 @@ paths: fundingStatus: "2" "/payments/offline/{paymentId}": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: number name: paymentId @@ -3181,8 +3168,6 @@ paths: fundingStatus: 2 /receipts: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get receipts responses: @@ -3474,7 +3459,6 @@ paths: - Receipt "/receipts/{receiptId}": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: receiptId @@ -3682,8 +3666,6 @@ paths: $ref: "#/components/responses/Receipt404" description: Delete a receipt /receipt-lines: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get all receipt lines tags: @@ -4228,7 +4210,6 @@ paths: description: The response sorted by which field description: "Get lines of a receipt, with pagination data" parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: receiptId @@ -4237,7 +4218,6 @@ paths: description: The unique ID of the receipt. "/receipts/{receiptId}/lines/{receiptLineId}": parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: receiptId diff --git a/docs/b2b-edition/specs/api-v3/order/order.yaml b/docs/b2b-edition/specs/api-v3/order/order.yaml index cd7f59b66..344ae7dc3 100644 --- a/docs/b2b-edition/specs/api-v3/order/order.yaml +++ b/docs/b2b-edition/specs/api-v3/order/order.yaml @@ -51,8 +51,6 @@ tags: description: Managing orders placed by buyers on stores using B2B Edition. paths: /orders: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get All Orders tags: @@ -578,8 +576,6 @@ paths: - code - data '/customers/{customerId}/orders/b2b': - parameters: - - $ref: "#/components/parameters/X-Store-Hash" put: tags: - Orders @@ -646,8 +642,6 @@ paths: - code - data /orders/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get Order Extra Field Configs tags: @@ -676,14 +670,6 @@ paths: - $ref: '#/components/schemas/orderExtraFields' components: parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. limit: name: limit in: query @@ -1405,6 +1391,16 @@ components: - meta examples: {} securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- @@ -1425,4 +1421,5 @@ components: type: apiKey in: header security: - - authToken: [] + - X-Auh-Token: [] + X-Store-Hash: [] diff --git a/docs/b2b-edition/specs/api-v3/payment/payment.yaml b/docs/b2b-edition/specs/api-v3/payment/payment.yaml index 054ff345f..5c7400012 100644 --- a/docs/b2b-edition/specs/api-v3/payment/payment.yaml +++ b/docs/b2b-edition/specs/api-v3/payment/payment.yaml @@ -30,13 +30,12 @@ servers: - url: 'https://api-b2b.bigcommerce.com/api/v3/io' security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Payment description: Company payment & store payment manage. paths: /payments: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Payment @@ -67,7 +66,6 @@ paths: $ref: "#/components/schemas/paymentTitle" /companies/{companyId}/payments: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -181,8 +179,6 @@ paths: data: errMsg: "Company Does not Exist" /company-payment-methods: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Payment @@ -245,7 +241,6 @@ paths: $ref: "#/components/schemas/paymentTitle" /companies/{companyId}/credit: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -310,7 +305,6 @@ paths: $ref: "#/components/schemas/creditStatus" /companies/{companyId}/payment-terms: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/companyId" get: tags: @@ -469,6 +463,16 @@ components: description: "Human-readable status message." securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- @@ -489,14 +493,6 @@ components: type: apiKey in: header parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. orderBy: name: orderBy in: query diff --git a/docs/b2b-edition/specs/api-v3/quote/quote.yaml b/docs/b2b-edition/specs/api-v3/quote/quote.yaml index 0a3e5ffca..9904fe002 100644 --- a/docs/b2b-edition/specs/api-v3/quote/quote.yaml +++ b/docs/b2b-edition/specs/api-v3/quote/quote.yaml @@ -69,13 +69,12 @@ servers: - url: https://api-b2b.bigcommerce.com/api/v3/io security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Quotes description: Request for Quote. paths: /rfq: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Quotes @@ -421,8 +420,6 @@ paths: meta: message: "Grand total amount not match for product list details" /rfq/custom/shipping-methods: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Quotes @@ -467,8 +464,6 @@ paths: meta: message: "Custom shipping is not enabled" /rfq/emails: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: tags: - Quotes @@ -581,8 +576,6 @@ paths: meta: message: "Invalid choice of email language" /rfq/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Quotes @@ -631,7 +624,6 @@ paths: $ref: "#/components/schemas/responsePagination" /rfq/{quote_id}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" get: tags: @@ -718,7 +710,6 @@ paths: $ref: "#/components/schemas/responseWithMessage" /rfq/{quote_id}/checkout: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" post: tags: @@ -783,7 +774,6 @@ paths: message: "Draft Quote can not be ordered" /rfq/{quote_id}/ordered: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" post: tags: @@ -839,7 +829,6 @@ paths: message: "Invalid BigCommerce order" /rfq/{quote_id}/pdf-export: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" post: tags: @@ -882,7 +871,6 @@ paths: example: "https://s3-us-west-2.amazonaws.com/bundleb2b-v2.0-quote-prod/B2B_Store%3AQN1234.pdf" /rfq/{quote_id}/shipping-rate: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" put: tags: @@ -983,7 +971,6 @@ paths: message: "Your quote does not have any shipping rate." /rfq/{quote_id}/shipping-rates: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: "#/components/parameters/quoteId" get: tags: @@ -1866,14 +1853,6 @@ components: description: "The number of records returned per page." default: 10 parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. offset: name: offset in: query @@ -1897,6 +1876,16 @@ components: description: "The internal numeric ID of the sales quote." example: 123456 securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- diff --git a/docs/b2b-edition/specs/api-v3/sales_staff/sales_staff.yaml b/docs/b2b-edition/specs/api-v3/sales_staff/sales_staff.yaml index 6d0a37679..d0b0c6824 100644 --- a/docs/b2b-edition/specs/api-v3/sales_staff/sales_staff.yaml +++ b/docs/b2b-edition/specs/api-v3/sales_staff/sales_staff.yaml @@ -21,12 +21,11 @@ servers: - url: https://api-b2b.bigcommerce.com/api/v3/io security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Sales Staff paths: /sales-staffs: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: tags: - Sales Staff @@ -108,7 +107,6 @@ paths: default: 200 /sales-staffs/{salesStaffId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: salesStaffId in: path required: true @@ -257,15 +255,6 @@ paths: type: string example: "Must be a valid boolean." components: - parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. schemas: companyId: type: integer @@ -310,6 +299,16 @@ components: description: "The total number of items matching the query." example: 179 securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- diff --git a/docs/b2b-edition/specs/api-v3/shopping_list/shopping_list.yaml b/docs/b2b-edition/specs/api-v3/shopping_list/shopping_list.yaml index 4cb7227ec..f50cf6e87 100644 --- a/docs/b2b-edition/specs/api-v3/shopping_list/shopping_list.yaml +++ b/docs/b2b-edition/specs/api-v3/shopping_list/shopping_list.yaml @@ -15,13 +15,12 @@ servers: - url: 'https://api-b2b.bigcommerce.com/api/v3/io' security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Shopping List description: Shopping List management. paths: /shopping-list: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get Shopping Lists tags: @@ -302,7 +301,6 @@ paths: name: limit description: Pagination limit for shopping list items parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: '#/components/parameters/shoppingListId' put: summary: Update a Shopping List @@ -471,7 +469,6 @@ paths: description: 'B2B Edition buyer user ID, you can enter a user ID for check if this user can delete this shopping list.' '/shopping-list/{shoppingListId}/items/{itemId}': parameters: - - $ref: "#/components/parameters/X-Store-Hash" - schema: type: string name: shoppingListId @@ -543,14 +540,6 @@ paths: parameters: [] components: parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. shoppingListId: name: shoppingListId in: path @@ -866,6 +855,16 @@ components: meta: message: Server Error securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- 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 da85fde4a..ff935dc38 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 @@ -22,13 +22,12 @@ servers: - url: 'https://api-b2b.bigcommerce.com/api/v3/io' security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Super Admin paths: /super-admins: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: summary: Create a Super Admin description: |- @@ -99,8 +98,6 @@ paths: default: "The user already exists." /super-admins/bulk: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: summary: Create Super Admins (Batch) description: |- @@ -231,8 +228,6 @@ paths: default: "This field is required" /super-admins/companies: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get All Companies with Assigned Super Admins description: |- @@ -312,7 +307,6 @@ paths: /super-admins/{superAdminId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: '#/components/parameters/superAdminId' put: summary: Update Super Admin Company Assignments @@ -359,7 +353,6 @@ paths: /super-admins/{superAdminId}/companies: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: '#/components/parameters/superAdminId' get: summary: Get A Super Admin's Assigned Companies @@ -394,7 +387,6 @@ paths: /super-admins/info/{superAdminId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: '#/components/parameters/superAdminId' get: summary: Get Super Admin Details @@ -470,8 +462,6 @@ paths: $ref: '#/components/responses/404' /companies/super-admins: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get All Super Admins with Assigned Companies description: |- @@ -541,7 +531,6 @@ paths: /companies/{companyId}/super-admins: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - $ref: '#/components/parameters/companyId' get: summary: Get Super Admins Assigned to a Company @@ -626,6 +615,16 @@ paths: components: securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |- @@ -806,14 +805,6 @@ components: message: type: string parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. extraFields: name: isIncludeExtraFields in: query diff --git a/docs/b2b-edition/specs/api-v3/user/user.yaml b/docs/b2b-edition/specs/api-v3/user/user.yaml index 83842b084..26afb5c08 100644 --- a/docs/b2b-edition/specs/api-v3/user/user.yaml +++ b/docs/b2b-edition/specs/api-v3/user/user.yaml @@ -30,12 +30,11 @@ servers: - url: 'https://api-b2b.bigcommerce.com/api/v3/io' security: - X-Auth-Token: [] + X-Store-Hash: [] tags: - name: Users paths: /users: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: Get All B2B users description: Returns a paginated list of B2B users with optional filters. @@ -198,8 +197,6 @@ paths: '422': $ref: "#/components/responses/post422" /users/bulk: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" post: summary: Bulk Create Users description: |- @@ -260,7 +257,6 @@ paths: $ref: "#/components/responses/post422" /users/{userId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: userId in: path required: true @@ -406,7 +402,6 @@ paths: default: "The last user in company can not be deleted." /users/customer/{customerId}: parameters: - - $ref: "#/components/parameters/X-Store-Hash" - name: customerId in: path required: true @@ -439,8 +434,6 @@ paths: '404': $ref: "#/components/responses/userId404" /users/extra-fields: - parameters: - - $ref: "#/components/parameters/X-Store-Hash" get: summary: List extra fields for users description: Returns paginated list of extra field definitions for users. @@ -791,14 +784,6 @@ components: type: string default: "User matching query does not exist." parameters: - X-Store-Hash: - name: X-Store-Hash - in: header - required: true - schema: - type: string - example: abc123 - description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled. limit: name: limit in: query @@ -831,6 +816,16 @@ components: schema: type: integer securitySchemes: + X-Store-Hash: + name: X-Store-Hash + description: |- + ### Authentication header + + | Header | Argument | Description | + |:-------|:---------|:------------| + | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. | + type: apiKey + in: header X-Auth-Token: name: X-Auth-Token description: |-