Skip to content

Response components for customer/metafields REST requests to Management API does not match runtime responses #912

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
tvhees opened this issue Apr 19, 2025 · 1 comment · May be fixed by #917

Comments

@tvhees
Copy link

tvhees commented Apr 19, 2025

Describe the bug
Response components are incorrect for GET /v3/customers/{customerId}/metafields and GET /v3/customers/{customerId}/metafields/{metafieldId}

To Reproduce

  1. Go to https://developer.bigcommerce.com/docs/rest-management/customers/metafields#get-customer-metafields
  2. Scroll to Response and note the shape of Body for the 200 response (object with property items)
  3. Make a GET request to https://api.bigcommerce.com/stores/{store_hash}/v3/customers/{customerId}/metafields for any valid store_hash and customerId
  4. Compare the runtime response shape (object with property data) to the shape in the documentation
  5. Repeat the above for https://developer.bigcommerce.com/docs/rest-management/customers/metafields#get-a-customer-metafield and https://api.bigcommerce.com/stores/{store_hash}/v3/customers/{customerId}/metafields/{metafieldId}

Expected behavior
Response components in the documentation should match what is received at runtime.

Screenshots
Documentation:
Image
Image

Actual responses:

Image
Image

tvhees added a commit to tvhees/docs that referenced this issue Apr 23, 2025
This should fix bigcommerce#912

I've followed the pattern set in catalog/products_catalog.v3.yml
@tvhees tvhees linked a pull request Apr 24, 2025 that will close this issue
@bc-terra
Copy link
Contributor

I see you added a pull request for this. I'll have a look over it and get things moving.

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 a pull request may close this issue.

2 participants