diff --git a/docs/storefront/graphql/orders.mdx b/docs/storefront/graphql/orders.mdx index b74b48388..749423e31 100644 --- a/docs/storefront/graphql/orders.mdx +++ b/docs/storefront/graphql/orders.mdx @@ -1,9 +1,5 @@ # GraphQL Storefront API: Orders (beta) - - This feature is currently in beta and the following operation is only available to participants. - - ## Overview The GraphQL Storefront `orders` object schema can power requests to your [headless](/docs/storefront/headless) storefront or [Stencil](/docs/storefront/stencil/start) theme supplying you with instant access to your Orders storefront data. To learn more about how the BigCommerce Storefront graph works, see [GraphQL Storefront API overview](/docs/storefront/graphql). @@ -47,6 +43,10 @@ To learn more about authenticating requests to the GraphQL Storefront API, see [ ## Example queries + +Before running the example queries, you will need to [sign in as a customer](https://developer.bigcommerce.com/docs/start/authentication/graphql-storefront#signing-customers-in) for the queries to work. + + ### Get all orders and details #### Filter by order status @@ -56,7 +56,7 @@ In this example, the query is set up to return a filtered list of all orders wit ```graphql filename="Example query: Get all orders and details" showLineNumbers copy query GetAllOrders { - site { + customer { orders(filters: {status: COMPLETED}) { edges { node { @@ -69,7 +69,6 @@ In this example, the query is set up to return a filtered list of all orders wit node { brand entityId - imageUrl name productOptions { name @@ -98,7 +97,7 @@ In this example, the query is set up to return a filtered list of all orders wit ```graphql filename="Example response: Get all orders and details" showLineNumbers copy { "data": { - "site": { + "customer": { "orders": { "edges": [ { @@ -114,7 +113,6 @@ In this example, the query is set up to return a filtered list of all orders wit "node": { "brand": "default", "entityId": "1", - "imageUrl": "https://cdn11.bigcommerce.com/s-xyzfeyee1r/products/111/images/371/smithjournal1.1721236910.386.513.jpg?c=1null", "name": "[Sample] Smith Journal 13", "productOptions": [ { @@ -179,7 +177,6 @@ In this example, the query is set up to get details for order #106. Use `entityI node { brand entityId - imageUrl name subTotalListPrice { currencyCode @@ -267,7 +264,6 @@ In this example, the query is set up to get details for order #106. Use `entityI "node": { "brand": "default", "entityId": 1, - "imageUrl": "https://cdn11.bigcommerce.com/s-xyzfeyee1r/products/111/images/371/smithjournal1.1721236910.386.513.jpg?c=1null", "name": "[Sample] Smith Journal 13", "subTotalListPrice": { "currencyCode": "USD", @@ -349,4 +345,4 @@ Join our [Developer community](/community) to share your feedback with us in the ### Community -* [Developer community](/community) \ No newline at end of file +* [Developer community](/community)