Skip to content

docs(orders): DEVDOCS-6330 [REST Storefront] [Orders] Add missing values for "include" query param #881

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 1 commit into
base: main
Choose a base branch
from

Conversation

BC-SEven
Copy link
Contributor

@BC-SEven BC-SEven commented Mar 26, 2025

DEVDOCS-6330

What changed?

  • Added missing values for include request param

Release notes draft

Anything else?

ping @bigcommerce/team-orders

Comment on lines +58 to +61
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories
- lineItems.physicalItems
- lineItems.physicalItems.giftWrapping
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't include gift wrapping as that is always included by default. So adding the parameter wont have an effect

- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
- lineItems.physicalItems.categories
Copy link
Contributor

Choose a reason for hiding this comment

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

probably out of scope of this PR: should we also update the schema for the "ItemPhysical.categories" :

categories:
type: array
description: Categories the item belongs to.
items:
type: object
properties: {}

@@ -55,12 +55,22 @@ paths:
type: string
enum:
- lineItems
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
- lineItems.physicalItems.options
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like options attribute is not definied in the ItemPhysical 🤔

@@ -55,12 +55,22 @@ paths:
type: string
enum:
- lineItems
- lineItems.physicalItems
- lineItems.physicalItems.socialMedia
Copy link
Contributor

Choose a reason for hiding this comment

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

socialMedia attribute also not defined in ItemPhysical

@BC-SEven
Copy link
Contributor Author

Ah I see we are still missing in the response body. Ill add those in as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants