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

  • items array[object] Required

    Represents physical storage, i.e. brick and mortar store or warehouse Used fully qualified namespaces in annotations for proper work of WebApi request parser

    Represents physical storage, i.e. brick and mortar store or warehouse Used fully qualified namespaces in annotations for proper work of WebApi request parser

    Hide items attributes Show items attributes object

    • source_code string

      Source code

    • name string

      Source name

    • email string

      Source email

    • contact_name string

      Source contact name

    • enabled boolean

      If source is enabled. For new entity can be null

    • description string

      Source description

    • latitude number

      Source latitude

    • longitude number

      Source longitude

    • country_id string

      Source country id

    • region_id integer

      Region id if source has registered region.

    • region string

      Region title if source has custom region

    • city string

      Source city

    • street string

      Source street name

    • postcode string

      Source post code

    • phone string

      Source phone number

    • fax string

      Source fax

    • use_default_carrier_config boolean

      Is need to use default config

    • carrier_links array[object]

      Represents relation between some physical storage and shipping method Used fully qualified namespaces in annotations for proper work of WebApi request parser

      Represents relation between some physical storage and shipping method Used fully qualified namespaces in annotations for proper work of WebApi request parser

      Hide carrier_links attributes Show carrier_links attributes object

      • carrier_code string

        Carrier code

      • position integer

        Position

      • extension_attributes object

        ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceInterface

      Hide extension_attributes attributes Show extension_attributes attributes object

      • is_pickup_location_active boolean
      • frontend_name string
      • frontend_description string
  • 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

      Groups two or more filters together using a logical OR

      Hide filter_groups attribute Show filter_groups attribute object

      • filters array[object]

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

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

        Hide filters attributes Show filters attributes object

        • field string Required

          Field

        • value string Required

          Value

        • condition_type string

          Condition type

    • sort_orders array[object]

      Data object for sort order.

      Data object for sort order.

      Hide sort_orders attributes Show sort_orders attributes object

      • 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

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • 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

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • 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

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • 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

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace