ReDoc documentation
Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.
200 Success.
401 Unauthorized
Internal Server error
Unexpected error
{- "items": [
- {
- "id": 0,
- "status": 0,
- "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": 0,
- "sales_representative_id": 0,
- "reject_reason": "string",
- "rejected_at": "string",
- "super_user_id": 0,
- "extension_attributes": {
- "applicable_payment_method": 0,
- "available_payment_methods": "string",
- "use_config_settings": 0,
- "quote_config": {
- "company_id": "string",
- "is_quote_enabled": true,
- "extension_attributes": { }
}, - "is_purchase_order_enabled": true,
- "applicable_shipping_method": 0,
- "available_shipping_methods": "string",
- "use_config_settings_shipping": 0
}
}
], - "search_criteria": {
- "filter_groups": [
- {
- "filters": [
- {
- "field": "string",
- "value": "string",
- "condition_type": "string"
}
]
}
], - "sort_orders": [
- {
- "field": "string",
- "direction": "string"
}
], - "page_size": 0,
- "current_page": 0
}, - "total_count": 0
}
Create or update a company account.
required | object (company-data-company-interface) Interface for Company entity. |
200 Success.
400 Bad Request
401 Unauthorized
Unexpected error
{- "company": {
- "id": 0,
- "status": 0,
- "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": 0,
- "sales_representative_id": 0,
- "reject_reason": "string",
- "rejected_at": "string",
- "super_user_id": 0,
- "extension_attributes": {
- "applicable_payment_method": 0,
- "available_payment_methods": "string",
- "use_config_settings": 0,
- "quote_config": {
- "company_id": "string",
- "is_quote_enabled": true,
- "extension_attributes": { }
}, - "is_purchase_order_enabled": true,
- "applicable_shipping_method": 0,
- "available_shipping_methods": "string",
- "use_config_settings_shipping": 0
}
}
}
{- "id": 0,
- "status": 0,
- "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": 0,
- "sales_representative_id": 0,
- "reject_reason": "string",
- "rejected_at": "string",
- "super_user_id": 0,
- "extension_attributes": {
- "applicable_payment_method": 0,
- "available_payment_methods": "string",
- "use_config_settings": 0,
- "quote_config": {
- "company_id": "string",
- "is_quote_enabled": true,
- "extension_attributes": { }
}, - "is_purchase_order_enabled": true,
- "applicable_shipping_method": 0,
- "available_shipping_methods": "string",
- "use_config_settings_shipping": 0
}
}