Skip to content

Feedback for “Locations” #1084

@pmad-odoo

Description

@pmad-odoo

Issue:
The Get Locations API documentation states that is_default can be used as a valid query parameter. However, when adding this parameter in a request, the API returns an error:

{
"status": 422,
"title": "The filter(s): is_default are not valid filter parameter(s).",
"type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes",
"errors": {}
}

Request Example:
GET /stores/{{store_id}}/v3/inventory/locations?is_default=true

Expected Behavior:
The API should allow filtering locations by the is_default field, as indicated in the documentation.

Actual Behavior:
The API rejects the is_default parameter with a 422 error, meaning it is not currently supported.

Suggested Update:
Please update the API documentation to either:

Remove is_default from the list of valid query parameters, or

Enable support for filtering by is_default in the API response.

Document URL: https://developer.bigcommerce.com/docs/rest-management/locations#get-locations:~:text=is_default%20in,is%20the%20default.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions