Skip to content

DEVDOCS-6237 - Refresh Quotes (SF) #902

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 4 commits into
base: main
Choose a base branch
from
Open

DEVDOCS-6237 - Refresh Quotes (SF) #902

wants to merge 4 commits into from

Conversation

bc-terra
Copy link
Contributor

@bc-terra bc-terra commented Apr 10, 2025

DEVDOCS-6237

What changed?

  • Code restructured to standard
  • Components implemented where possible
  • Added descriptive copy for fields and parameters
  • Added introduction and endpoint descriptions

Release notes draft

  • As part of our ongoing content refresh for B2B Edition developer documentation, we've fully refreshed the Storefront Quotes documentation. This includes:
    • New, thorough descriptive copy
    • Inclusion of previously missing fields from several endpoints

Anything else?

ping @bc-terra @CNanninga

- Code restructured to standard
- Components implemented where possible
- Still lacking descriptive copy
@bc-terra bc-terra added the on hold Work is being place in a hold status. Will need follow up. label Apr 10, 2025
Added introduction and endpoint descriptions
Filled in schemas created by Terra with parameter and field descriptions
Added new schemas for missing fields and parameters
@bc-Vince bc-Vince self-assigned this May 6, 2025
@bc-Vince bc-Vince added ready for review This PR is complete and awaiting a review. and removed on hold Work is being place in a hold status. Will need follow up. labels May 6, 2025
@bc-Vince bc-Vince requested review from snaderiBC and BC-EEspinosa May 6, 2025 15:13
@bc-terra
Copy link
Contributor Author

bc-terra commented May 7, 2025

@bc-Vince There was a repeated data error which I've corrected just by removing duplicate content.


This endpoint **does not** convert an unpurchased quote into a new BigCommerce order.

The endppooint updates the existing order with the shipping and tax information provided in the request.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: "endppooint"

Copy link
Contributor

Choose a reason for hiding this comment

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

The revision still has an extra "o".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
The endppooint updates the existing order with the shipping and tax information provided in the request.
The endpoint updates the existing order with the shipping and tax information provided in the request.

- Quotes
summary: "Assign a Quote to a BigCommerce Order"
operationId: post-rfq-quote_id-ordered
description: |-
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we might need a little more clarity on the use case here.

I recall from the server-to-server "Create Order" endpoint, for example, that B2B Edition automatically takes care of creating the B2B order and that endpoint just exists to "override" the behavior or in case it fails. Is this a similar situation? Is this endpoint/mutation required to complete the workflow, or does it usually happen automatically when the cart was created from the quote in the first place?

Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding that this endpoint/mutation also occurs automatically when a buyer completes checkout and creates an order from the quote. I'm guessing this would be needed if one were to build a completely custom checkout in order to sync quotes with their corresponding order.

@BC-EEspinosa @snaderiBC Can either of you confirm the intended use case for this endpoint/mutation?

- key: "defaultExpirationDate"
value: "45"
- key: "defaultTermsAndConditions"
value: "hank you for the opportunity to provide this quote! Please note the following:\n - Quotes are valid for 30 days unless otherwise stated.\n - Pricing is subject to change at any time.\n - Please note, the shipping and tax quoted are estimates only. Final shipping and tax will be calculated during checkout and may be billed post sale.\n - Due to fluctuating shipping rates, LTL shipping calculations are only estimates. Final LTL rates will be determined by quote upon shipment and may be billed post sale. Also, if a lift gate is required an additional fee will apply if not included in this quote.\n - Please contact your Technical Sales Representative, call 512-11-1111, or email [email protected] for assistance."
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: "hank you"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
value: "hank you for the opportunity to provide this quote! Please note the following:\n - Quotes are valid for 30 days unless otherwise stated.\n - Pricing is subject to change at any time.\n - Please note, the shipping and tax quoted are estimates only. Final shipping and tax will be calculated during checkout and may be billed post sale.\n - Due to fluctuating shipping rates, LTL shipping calculations are only estimates. Final LTL rates will be determined by quote upon shipment and may be billed post sale. Also, if a lift gate is required an additional fee will apply if not included in this quote.\n - Please contact your Technical Sales Representative, call 512-11-1111, or email [email protected] for assistance."
value: "Thank you for the opportunity to provide this quote! Please note the following:\n - Quotes are valid for 30 days unless otherwise stated.\n - Pricing is subject to change at any time.\n - Please note, the shipping and tax quoted are estimates only. Final shipping and tax will be calculated during checkout and may be billed post sale.\n - Due to fluctuating shipping rates, LTL shipping calculations are only estimates. Final LTL rates will be determined by quote upon shipment and may be billed post sale. Also, if a lift gate is required an additional fee will apply if not included in this quote.\n - Please contact your Technical Sales Representative, call 512-11-1111, or email [email protected] for assistance."

description: |-
Retrieves basic information about the store, Company, sales rep, and extra field information. This is used in the storefront to provide basic information on a quote’s detail page, such as the quote logo and Sales Staff user details.

The 'companyId' and 'salesRepId' parameters must be included in the query in order to return Company and sales rep information respectively. If omitted, the response still contains store and extra field information.
Copy link
Contributor

Choose a reason for hiding this comment

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

What's our standard format for displaying querystring parameters: Single quotes or backticks? The rfq/configs endpoint has a similar note where storeHash is in backticks. That's a querystring parameter in that context, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
The 'companyId' and 'salesRepId' parameters must be included in the query in order to return Company and sales rep information respectively. If omitted, the response still contains store and extra field information.
The `companyId` and `salesRepId` parameters must be included in the query in order to return Company and sales rep information respectively. If omitted, the response still contains store and extra field information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for review This PR is complete and awaiting a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants