Query parameters

• searchCriteria[filterGroups][0][filters][0][field] string

  Field

• searchCriteria[filterGroups][0][filters][0][value] string

  Value

• searchCriteria[filterGroups][0][filters][0][conditionType] string

  Condition type

• searchCriteria[sortOrders][0][field] string

  Sorting field.

• searchCriteria[sortOrders][0][direction] string

  Sorting direction.

• searchCriteria[pageSize] integer

  Page size.

• searchCriteria[currentPage] integer

  Current page.

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  Search results of Repository::getList method Used fully qualified namespaces in annotations for proper work of WebApi request parser

  • items array[object] Required

    Represents product aggregation among some different physical storages (in technical words, it is an index) Used fully qualified namespaces in annotations for proper work of WebApi request parser

    Hide items attributes Show items attributes object

    Represents product aggregation among some different physical storages (in technical words, it is an index) Used fully qualified namespaces in annotations for proper work of WebApi request parser

    • stock_id integer

      Stock id

    • name string

      Stock name

    • extension_attributes object

      TODO: temporal fix of extension classes generation during installation ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockInterface

      Hide extension_attributes attribute Show extension_attributes attribute object

      • sales_channels array[object]

        Represents sales channels (which are a linkage between stocks and websites, customer groups, etc.) Used fully qualified namespaces in annotations for proper work of WebApi request parser

        Hide sales_channels attributes Show sales_channels attributes object

        Represents sales channels (which are a linkage between stocks and websites, customer groups, etc.) Used fully qualified namespaces in annotations for proper work of WebApi request parser

        • type string

          Sales channel type

        • code string

          Sales channel code

        • extension_attributes object

          ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\SalesChannelInterface

  • search_criteria object Required

    Search criteria interface.

    Hide search_criteria attributes Show search_criteria attributes object

    • filter_groups array[object] Required

      Groups two or more filters together using a logical OR

      Hide filter_groups attribute Show filter_groups attribute object

      Groups two or more filters together using a logical OR

      • filters array[object]

        Filter which can be used by any methods from service layer.

        Hide filters attributes Show filters attributes object

        Filter which can be used by any methods from service layer.

        • field string Required

          Field

        • value string Required

          Value

        • condition_type string

          Condition type

    • sort_orders array[object]

      Data object for sort order.

      Hide sort_orders attributes Show sort_orders attributes object

      Data object for sort order.

      • field string Required

        Sorting field.

      • direction string Required

        Sorting direction.

    • page_size integer

      Page size.

    • current_page integer

      Current page.

  • total_count integer Required

    Total count.

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace