company/

company/

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.

Request
query Parameters
searchCriteria[currentPage]
integer

Current page.

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[pageSize]
integer

Page size.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[sortOrders][0][field]
string

Sorting field.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

company/

post/V1/company/

Create or update a company account.

Request
Request Body schema:
required
object (company-data-company-interface)

Interface for Company entity.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "company": {
    }
}
Response samples
{
  • "id": 0,
  • "status": 0,
  • "company_name": "string",
  • "legal_name": "string",
  • "company_email": "string",
  • "vat_tax_id": "string",
  • "reseller_id": "string",
  • "comment": "string",
  • "street": [
    ],
  • "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": {
    }
}