Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVDOCS-5655-updates #569

Merged
merged 3 commits into from
Oct 9, 2024
Merged

DEVDOCS-5655-updates #569

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8c0d22
DEVDOCS-5655-updates
bc-traciporter Oct 8, 2024
b497e12
Update order.yaml
bc-traciporter Oct 8, 2024
d793d35
Update order.yaml - addressed Nate's comments
bc-traciporter Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/b2b-edition/specs/storefront/storefront/catalog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
100 changes: 77 additions & 23 deletions docs/b2b-edition/specs/storefront/storefront/order.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ info:
title: Order
version: '1.0'
description: Company based order management.
contact:
name: BigCommerce
url: 'https://www.bigcommerce.com'
email: [email protected]
servers:
- url: 'https://api-b2b.bigcommerce.com/api/v2'
security:
- BearerToken: []
paths:
/orders:
get:
Expand Down Expand Up @@ -291,7 +297,7 @@ paths:
description: Order status
description: |-
Get orders.
<br>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:
Expand Down Expand Up @@ -351,27 +357,67 @@ paths:
isSaveOrderComment:
type: string
description: If save order comment
extraFields:
type: array
items:
type: object
properties:
fieldName:
type: string
description: Extra field name
fieldValue:
type: string
description: Extra field value
extraInt1:
type: string
description: Order extra int field 1
extraInt2:
type: string
description: Order extra int field 2
extraInt3:
type: string
description: Order extra int field 3
extraInt4:
type: string
description: Order extra int field 4
extraInt5:
type: string
description: Order extra int field 5
extraStr1:
type: string
description: Order extra str field 1
extraStr2:
type: string
description: Order extra str field 2
extraStr3:
type: string
description: Order extra str field 3
extraStr4:
type: string
description: Order extra str field 4
extraStr5:
type: string
description: Order extra str field 5
extraText:
type: string
description: Order extra text field
extraInfo:
oneOf:
- type: string
- type: object
properties:
addressExtraFields:
type: object
properties:
shippingAddressExtraFields:
type: array
items:
type: object
properties:
fieldName:
type: string
fieldValue:
type: string
description: order extra info such as address extra fields
required:
- orderId
description: |-
Create an order in the BigCommerce store.
<br>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
Expand Down Expand Up @@ -431,8 +477,8 @@ paths:
name: 'orderIds[]'
description: Unique order ID
description: |-
Get order's images.
<br>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
Expand Down Expand Up @@ -530,7 +576,7 @@ paths:
operationId: get-orders-orderId-products
description: |-
Get order products by orderId.
<br>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':
Expand Down Expand Up @@ -967,6 +1013,11 @@ paths:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
is_email_opt_in:
type: boolean
credit_card_type: {}
Expand Down Expand Up @@ -1711,7 +1762,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.
<br>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:
Expand Down Expand Up @@ -2028,17 +2079,20 @@ paths:
description: Query string
description: |-
Get ordered products.
<br>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
Loading