ReDoc documentation

company/{companyId}

company/{companyId}

Returns company details.

Request
path Parameters
companyId
required
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

get/V1/company/{companyId}
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": {
    }
}

company/{companyId}

Delete a company. Customers belonging to a company are not deleted with this request.

Request
path Parameters
companyId
required
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

delete/V1/company/{companyId}
Response samples
true

company/{companyId}

Create or update a company account.

Request
path Parameters
companyId
required
string
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

put/V1/company/{companyId}
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": {
    }
}