company/{companyId}

get/V1/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

Response samples

200
400
401
default

{"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": {"quote_config": {"company_id": "string",
"is_quote_enabled": true,
"extension_attributes": { }
},
"applicable_payment_method": 0,
"available_payment_methods": "string",
"use_config_settings": 0,
"is_purchase_order_enabled": true,
"applicable_shipping_method": 0,
"available_shipping_methods": "string",
"use_config_settings_shipping": 0
}
}

company/{companyId}

delete/V1/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

Response samples

200
400
401
default

true

company/{companyId}

put/V1/company/{companyId}

Create or update a company account.

Request

path Parameters

companyId

required

string

Request Body schema:
application/json

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

Payload

{"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": {"quote_config": {"company_id": "string",
"is_quote_enabled": true,
"extension_attributes": { }
},
"applicable_payment_method": 0,
"available_payment_methods": "string",
"use_config_settings": 0,
"is_purchase_order_enabled": true,
"applicable_shipping_method": 0,
"available_shipping_methods": "string",
"use_config_settings_shipping": 0
}
}
}

Response samples

200
400
401
default

{"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": {"quote_config": {"company_id": "string",
"is_quote_enabled": true,
"extension_attributes": { }
},
"applicable_payment_method": 0,
"available_payment_methods": "string",
"use_config_settings": 0,
"is_purchase_order_enabled": true,
"applicable_shipping_method": 0,
"available_shipping_methods": "string",
"use_config_settings_shipping": 0
}
}

➔ Next to company/{parentId}/relations

company/{companyId}

company/{companyId}

path Parameters

company/{companyId}

path Parameters

company/{companyId}

path Parameters

Request Body schema: application/jsonapplication/xmlapplication/json

Request Body schema:
application/json