Skip to content

DEVDOCS-6253 - Content Refresh - "Orders" (Storefront) #975

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

bc-Vince
Copy link
Contributor

@bc-Vince bc-Vince commented Jun 12, 2025

Reformatted file with reusable schemas.
Added new copy.
Added missing fields and parameters.
Called out legacy extra fields.

DEVDOCS-6253

What changed?

  • Introduction presents helpful usage information, including the Company user permissions needed for the user associated with the storefront authToken.
  • Endpoints now include summaries with usage information.
  • Request and response bodies are up-to-date, showing all available fields and parameters.
  • YAML file is organized into several schema to reduce redundant text lines and improve efficiency for subsequent edits.

Release notes draft

  • As part of our ongoing content refresh for B2B Edition developer documentation, we've fully refreshed the Server-to-Server Quotes documentation. This includes
    • New, thorough descriptive copy
    • Explanation of legacy information fields
    • INclusion of previously-missing fields for all endpoints

Anything else?

ping @bc-terra

Reformatted file with reusable schemas.
Added new copy.
Added missing fields and parameters.
Called out legacy extra fields.
@bc-Vince bc-Vince added the ready for review This PR is complete and awaiting a review. label Jun 12, 2025
Copy link
Contributor

@CNanninga CNanninga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For these general endpoints: Verbiage like "by the Company user" is being used. But don't roles and permissions play into this? e.g., can't a particular company user have their permissions set such that ALL the company's orders are viewable by them? Or does that not affect the responses of these endpoints the way I'm thinking? (It's been a while since I was in the weeds on it.)

description: |-
Generates an order record in B2B Edition after a Company user places an order.

This occurs automatically; however, you can populate extra information on a B2B order by using a [webhook](/docs/integrations/webhooks) that first listens for BigCommerce order creation and then calls the Create an Order endpoint. The request must be made within 10 seconds of an order's creation for it to be successful.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little confused on this. I just finished reviewing the server-to-server Orders API endpoints PR, and the same functionality exists there. Since this capability exists for the specific purpose of doing an asynchronous "override" of the native behavior, I'm unclear why there's a Storefront API version. If I have an app/integration and using a webhook to preemptively create a B2B order, what is the use case for doing that with a Storefront endpoint instead of Management?

Might just be worth clarifying with the B2B team.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bc-victor Do you know what the use case is for this Storefront endpoint?

@bc-Vince bc-Vince added need-SME-review A subject matter expert is needed to review. and removed ready for review This PR is complete and awaiting a review. labels Jun 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need-SME-review A subject matter expert is needed to review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants