Find Sources by SearchCriteria SearchCriteria is not required because load all stocks is useful case

GET /V1/inventory/sources

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 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
  
  Represents physical storage, i.e. brick and mortar store or warehouse Used fully qualified namespaces in annotations for proper work of WebApi request parser
  
  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
  
  Hide carrier_links attributes Show carrier_links attributes object
  
  Represents relation between some physical storage and shipping method Used fully qualified namespaces in annotations for proper work of WebApi request parser
  
  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
  
  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

GET /V1/inventory/sources

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/inventory/sources

Response examples (200)

{
  "items": [
    {
      "source_code": "string",
      "name": "string",
      "email": "string",
      "contact_name": "string",
      "enabled": true,
      "description": "string",
      "latitude": 42.0,
      "longitude": 42.0,
      "country_id": "string",
      "region_id": 42,
      "region": "string",
      "city": "string",
      "street": "string",
      "postcode": "string",
      "phone": "string",
      "fax": "string",
      "use_default_carrier_config": true,
      "carrier_links": [
        {
          "carrier_code": "string",
          "position": 42,
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "is_pickup_location_active": true,
        "frontend_name": "string",
        "frontend_description": "string"
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}