Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.
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 (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<id type="integer">42</id>
<status type="integer">42</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 type="array">
<street>string</street>
</street>
<city>string</city>
<country-id>string</country-id>
<region>string</region>
<region-id>string</region-id>
<postcode>string</postcode>
<telephone>string</telephone>
<customer-group-id type="integer">42</customer-group-id>
<sales-representative-id type="integer">42</sales-representative-id>
<reject-reason>string</reject-reason>
<rejected-at>string</rejected-at>
<super-user-id type="integer">42</super-user-id>
<extension-attributes>
<applicable-payment-method type="integer">42</applicable-payment-method>
<available-payment-methods>string</available-payment-methods>
<use-config-settings type="integer">42</use-config-settings>
<quote-config>
<company-id>string</company-id>
<is-quote-enabled type="boolean">true</is-quote-enabled>
<extension-attributes>
</extension-attributes>
</quote-config>
<is-purchase-order-enabled type="boolean">true</is-purchase-order-enabled>
<applicable-shipping-method type="integer">42</applicable-shipping-method>
<available-shipping-methods>string</available-shipping-methods>
<use-config-settings-shipping type="integer">42</use-config-settings-shipping>
<shipping-fee type="float">42.0</shipping-fee>
<return-item-fee type="float">42.0</return-item-fee>
<return-sale-item-fee type="float">42.0</return-sale-item-fee>
<return-outlet-item-fee type="float">42.0</return-outlet-item-fee>
<logo>string</logo>
<locale>string</locale>
<customer-service-url>string</customer-service-url>
<pay-by-link-theme-id>string</pay-by-link-theme-id>
<logo-url>string</logo-url>
<order-success-url>string</order-success-url>
<allowed-countries>string</allowed-countries>
<rma-url>string</rma-url>
<stockhubwebhook-enabled type="boolean">true</stockhubwebhook-enabled>
<stockhubwebhook-order-url>string</stockhubwebhook-order-url>
<stockhubwebhook-invoice-url>string</stockhubwebhook-invoice-url>
<stockhubwebhook-shipment-url>string</stockhubwebhook-shipment-url>
<stockhubwebhook-creditmemo-url>string</stockhubwebhook-creditmemo-url>
<stockhubwebhook-rma-url>string</stockhubwebhook-rma-url>
<stockhubwebhook-apikey>string</stockhubwebhook-apikey>
</extension-attributes>
</item>
</items>
<search-criteria>
<filter-groups type="array">
<filter-group>
<filters type="array">
<filter>
<field>string</field>
<value>string</value>
<condition-type>string</condition-type>
</filter>
</filters>
</filter-group>
</filter-groups>
<sort-orders type="array">
<sort-order>
<field>string</field>
<direction>string</direction>
</sort-order>
</sort-orders>
<page-size type="integer">42</page-size>
<current-page type="integer">42</current-page>
</search-criteria>
<total-count type="integer">42</total-count>
</root>
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 (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
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 (500)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
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"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>