Returns the list of companies

GET /V1/company/

Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.

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
  
  Interface for Company entity.
  
  Interface for Company entity.
  
  Hide items attributes Show items attributes object
  
  id integer
  
  Id.
  
  status integer
  
  Status.
  
  company_name string
  
  Company name.
  
  legal_name string
  
  Legal name.
  
  company_email string
  
  Company email.
  
  vat_tax_id string
  
  Vat tax id.
  
  reseller_id string
  
  Reseller Id.
  
  comment string
  
  Comment.
  
  street array[string] Required
  
  Street.
  
  city string
  
  City.
  
  country_id string
  
  Country.
  
  region string
  
  Region.
  
  region_id string
  
  Region Id.
  
  postcode string
  
  Postcode.
  
  telephone string
  
  Telephone.
  
  customer_group_id integer Required
  
  Customer Group Id.
  
  sales_representative_id integer Required
  
  Sales Representative Id.
  
  reject_reason string Required
  
  Reject Reason.
  
  rejected_at string Required
  
  Rejected at time.
  
  super_user_id integer Required
  
  Company admin customer id.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  applicable_payment_method integer
  
  available_payment_methods string
  
  use_config_settings integer
  
  quote_config object
  
  Interface CompanyQuoteConfigInterface
  
  Hide quote_config attributes Show quote_config attributes object
  
  company_id string
  
  Company id
  
  is_quote_enabled boolean Required
  
  Quote enabled for company
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CompanyQuoteConfigInterface
  
  is_purchase_order_enabled boolean
  
  applicable_shipping_method integer
  
  available_shipping_methods string
  
  use_config_settings_shipping integer
  
  shipping_fee number
  
  return_item_fee number
  
  return_sale_item_fee number
  
  return_outlet_item_fee number
  
  logo string
  
  locale string
  
  customer_service_url string
  
  pay_by_link_theme_id string
  
  logo_url string
  
  order_success_url string
  
  allowed_countries string
  
  rma_url string
  
  stockhubwebhook_enabled boolean
  
  stockhubwebhook_order_url string
  
  stockhubwebhook_invoice_url string
  
  stockhubwebhook_shipment_url string
  
  stockhubwebhook_creditmemo_url string
  
  stockhubwebhook_rma_url string
  
  stockhubwebhook_apikey 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
500

Internal Server 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
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

GET /V1/company/

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/company/'

Response examples (200)

{
  "items": [
    {
      "id": 42,
      "status": 42,
      "company_name": "string",
      "legal_name": "string",
      "company_email": "string",
      "vat_tax_id": "string",
      "reseller_id": "string",
      "comment": "string",
      "street": [
        "string"
      ],
      "city": "string",
      "country_id": "string",
      "region": "string",
      "region_id": "string",
      "postcode": "string",
      "telephone": "string",
      "customer_group_id": 42,
      "sales_representative_id": 42,
      "reject_reason": "string",
      "rejected_at": "string",
      "super_user_id": 42,
      "extension_attributes": {
        "applicable_payment_method": 42,
        "available_payment_methods": "string",
        "use_config_settings": 42,
        "quote_config": {
          "company_id": "string",
          "is_quote_enabled": true,
          "extension_attributes": {}
        },
        "is_purchase_order_enabled": true,
        "applicable_shipping_method": 42,
        "available_shipping_methods": "string",
        "use_config_settings_shipping": 42,
        "shipping_fee": 42.0,
        "return_item_fee": 42.0,
        "return_sale_item_fee": 42.0,
        "return_outlet_item_fee": 42.0,
        "logo": "string",
        "locale": "string",
        "customer_service_url": "string",
        "pay_by_link_theme_id": "string",
        "logo_url": "string",
        "order_success_url": "string",
        "allowed_countries": "string",
        "rma_url": "string",
        "stockhubwebhook_enabled": true,
        "stockhubwebhook_order_url": "string",
        "stockhubwebhook_invoice_url": "string",
        "stockhubwebhook_shipment_url": "string",
        "stockhubwebhook_creditmemo_url": "string",
        "stockhubwebhook_rma_url": "string",
        "stockhubwebhook_apikey": "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 (500)

{
  "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"
}