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

[bc-Vince]

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

[bc-terra]

Suggested change

	- $ref: "#/components/schemas/responseSuccess"
	- properties:
	data:
	type: array
	items:
	properties:
	orderId:
	$ref: '#/components/schemas/orderId'
	required:
	- orderId
	- $ref: "#/components/schemas/responseArray"
	- properties:
	data:
	items:
	properties:
	orderId:
	$ref: '#/components/schemas/orderId'
	required:
	- orderId

Changing the schema to one I'll add in another comment. Also removing redundancies and adjusting alignment on the required list

[bc-terra]

Suggested change

	- $ref: "#/components/schemas/responseSuccess"
	- properties:
	data:
	type: array
	items:
	type: object
	properties:
	orderId:
	$ref: '#/components/schemas/orderId'
	imageUrl:
	type: string
	minLength: 1
	description: The image URL for a product in the order.
	example: "https://mybcstore.com/images/products/12345/main.jpg"
	required:
	- orderId
	- imageUrl
	- $ref: "#/components/schemas/responseArray"
	- properties:
	data:
	items:
	properties:
	orderId:
	$ref: '#/components/schemas/orderId'
	imageUrl:
	type: string
	minLength: 1
	description: The image URL for a product in the order.
	example: "https://mybcstore.com/images/products/12345/main.jpg"
	required:
	- orderId
	- imageUrl

See note above for rationale

[bc-terra]

Suggested change

	- $ref: "#/components/schemas/responseSuccess"
	- properties:
	data:
	type: array
	items:
	type: object
	properties:
	productId:
	$ref: '#/components/schemas/productId'
	quantity:
	$ref: '#/components/schemas/quantity'
	variantId:
	$ref: '#/components/schemas/variantId'
	optionList:
	$ref: '#/components/schemas/optionList_SIMPLE'
	required:
	- productId
	- quantity
	- variantId
	- $ref: "#/components/schemas/responseArray"
	- properties:
	data:
	items:
	properties:
	productId:
	$ref: '#/components/schemas/productId'
	quantity:
	$ref: '#/components/schemas/quantity'
	variantId:
	$ref: '#/components/schemas/variantId'
	optionList:
	$ref: '#/components/schemas/optionList_SIMPLE'
	required:
	- productId
	- quantity
	- variantId

See note above for rationale

[bc-terra]

Suggested change

	responseObject:
	type: object
	properties:
	code:
	type: integer
	description: "HTTP Response Code"
	default: '200'
	message:
	type: string
	description: "Response message"
	default: 'SUCCESS'
	data:
	type: object
	responseSuccess:
	responseObject:
	type: object
	properties:
	code:
	type: integer
	description: "HTTP Response Code"
	default: '200'
	message:
	type: string
	description: "Response message"
	default: 'SUCCESS'
	data:
	type: object
	responseArray:
	type: object
	properties:
	code:
	type: integer
	description: "HTTP Response Code"
	default: '200'
	message:
	type: string
	description: "Response message"
	default: 'SUCCESS'
	data:
	type: array
	items:
	type: object
	responseSuccess:

Adding this schema to support the other three suggestions.
Without these four adjustments, it works fine in Swagger, but our own renderer gets lost in the muck.