-
Notifications
You must be signed in to change notification settings - Fork 49
DEVDOCS-6249 - Content Refresh S2S Super Admin #996
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
base: main
Are you sure you want to change the base?
Conversation
Reformatted file with reusable schemas. Added new copy. Added missing fields and parameters. Adjusted responses to clarify structure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know if you need additional clarification on any of the questions in the comments.
uuid: | ||
type: string | ||
format: uuid | ||
description: "The UUID associated with the Super Admin's B2B Edition user account." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this field blank/null/etc if the Super Admin only has a storefront account and not a backend account?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From testing, whether/how uuid
shows depends if it has a defined value. If the customer account doesn't have a UUID assigned, some endpoints will omit it. Endpoints that always show the UUID list it as an empty string, e.g. "uuid": ""
in the response. Since BigCommerce customers usually don't have a UUID assigned by default, this is blank unless the merchant explicitly includes it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That might be worth calling out, since the field is included in at least one endpoint.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: "The UUID associated with the Super Admin's B2B Edition user account." | |
description: |- | |
An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default. | |
> NOTE | |
> Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details. | |
> | |
> Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bc-Vince how's this for a revision?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bc-terra This looks great to me!
Co-authored-by: bc-Vince <[email protected]>
DEVDOCS-6249
Reformatted file with reusable schemas.
Added new copy.
Added missing fields and parameters.
Adjusted responses to clarify structure.
What changed?
Release notes draft
Anything else?
ping { @bc-Vince @CNanninga @BC-EEspinosa }