diff --git a/docs/b2b-edition/specs/storefront/storefront/catalog.yaml b/docs/b2b-edition/specs/storefront/storefront/catalog.yaml index 143a8c7e5..e156c3ea2 100644 --- a/docs/b2b-edition/specs/storefront/storefront/catalog.yaml +++ b/docs/b2b-edition/specs/storefront/storefront/catalog.yaml @@ -374,7 +374,7 @@ components: ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| - |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| Obtained using the [BigCommerce Current Customer API](/docs/rest-authentication/current-customer) endpoint. | + |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST Storefront API](/b2b-edition/docs/authentication#rest-storefront-api) section of the [Authentication for hosted storefront](https://developer.bigcommerce.com/b2b-edition/docs/authentication) article. | type: apiKey in: header tags: diff --git a/docs/b2b-edition/specs/storefront/storefront/order.yaml b/docs/b2b-edition/specs/storefront/storefront/order.yaml index 81d7445c7..eb068099f 100644 --- a/docs/b2b-edition/specs/storefront/storefront/order.yaml +++ b/docs/b2b-edition/specs/storefront/storefront/order.yaml @@ -3,8 +3,14 @@ info: title: Order version: '1.0' description: Company based order management. + contact: + name: BigCommerce + url: 'https://www.bigcommerce.com' + email: support@bigcommerce.com servers: - url: 'https://api-b2b.bigcommerce.com/api/v2' +security: + - BearerToken: [] paths: /orders: get: @@ -291,7 +297,7 @@ paths: description: Order status description: |- Get orders. -
Equivalent Storefront GraphQL API Query: `allOrders`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Equivalent Storefront GraphQL API Query: `allOrders`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order post: @@ -366,12 +372,12 @@ paths: - orderId description: |- Create an order in the BigCommerce store. -
Equivalent Storefront GraphQL API Mutation: `createOrder`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Equivalent Storefront GraphQL API Mutation: `createOrder`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order /orders/images: get: - summary: Get Order's Images + summary: Get Order Images responses: '200': description: OK @@ -431,8 +437,8 @@ paths: name: 'orderIds[]' description: Unique order ID description: |- - Get order's images. -
Equivalent Storefront GraphQL API Query: `orderImages`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Get order images. + Equivalent Storefront GraphQL API Query: `orderImages`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order x-internal: true @@ -530,7 +536,7 @@ paths: operationId: get-orders-orderId-products description: |- Get order products by orderId. -
Equivalent Storefront GraphQL API Query: `orderProducts`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Equivalent Storefront GraphQL API Query: `orderProducts`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order '/orders/{orderId}/details': @@ -967,6 +973,11 @@ paths: type: array items: type: object + properties: + name: + type: string + value: + type: string is_email_opt_in: type: boolean credit_card_type: {} @@ -1711,7 +1722,7 @@ paths: operationId: get-orders-orderId-details description: |- Get order detail by orderId. Please refer to [BigCommerce API](https://developer.bigcommerce.com/api-reference/store-management/orders/orders/getanorder) for detailed parameter introduction. -
Equivalent Storefront GraphQL API Query: `order`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Equivalent Storefront GraphQL API Query: `order`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order /ordered-products: @@ -2028,17 +2039,20 @@ paths: description: Query string description: |- Get ordered products. -
Equivalent Storefront GraphQL API Query: `orderedProducts`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). + Equivalent Storefront GraphQL API Query: `orderedProducts`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). tags: - Order components: schemas: {} securitySchemes: - authToken: - name: authToken + BearerToken: + name: BearerToken + description: |- + ### Authentication header + | Header | Argument | Description | + |:-------|:---------|:------------| + |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST Storefront API](/b2b-edition/docs/authentication#rest-storefront-api) section of the [Authentication for hosted storefront](https://developer.bigcommerce.com/b2b-edition/docs/authentication) article. | type: apiKey in: header -security: - - authToken: [] tags: - name: Order