docs(orders: DEVDOCS-6459 improve dev docs for sideloading order cons… #1026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
reference/orders.v2.oas2.yml
Outdated
| * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future. | ||
| * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future. | ||
| * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. | ||
| * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments. |
There was a problem hiding this comment.
🍹 We might want to clear up the language around "This implies include=consignments".
I'm not sure if it means that consignments.line_items is considered as being a superset of consignments (line_items alone is the same as having both) or requiring consignments to be part of the include param in order for line_items to function.
There was a problem hiding this comment.
Hi @matt-evangelidis, did you have any alternative wording in mind for this?
Maybe something like:
- This will also includes the resources associated with
include=consignments
There was a problem hiding this comment.
Yep, @BC-SEven, that's just fine and clarifies exactly the question I had.
YevenLourance
previously approved these changes
Jul 30, 2025
BC-SEven
force-pushed
the
DEVDOCS-6459
branch
2 times, most recently
from
5422ff2 to
622b8d8
Compare
matt-evangelidis
approved these changes
Aug 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ignments
[DEVDOCS-6459 ]
What changed?
Release notes draft
Anything else?
ping @bigcommerce/team-orders