Path parameters

• companyId integer Required

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • id integer

    Id.

  • status integer

    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 array[string] Required

    Street.

  • city string

    City.

  • country_id string

    Country.

  • region string

    Region.

  • region_id string

    Region Id.

  • postcode string

    Postcode.

  • telephone string

    Telephone.

  • customer_group_id integer Required

    Customer Group Id.

  • sales_representative_id integer Required

    Sales Representative Id.

  • reject_reason string Required

    Reject Reason.

  • rejected_at string Required

    Rejected at time.

  • super_user_id integer Required

    Company admin customer id.

  • extension_attributes object

    ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface

    Hide extension_attributes attributes Show extension_attributes attributes object

    • applicable_payment_method integer
    • available_payment_methods string
    • use_config_settings integer
    • quote_config object

      Interface CompanyQuoteConfigInterface

      Hide quote_config attributes Show quote_config attributes object

      • company_id string

        Company id

      • is_quote_enabled boolean Required

        Quote enabled for company

      • extension_attributes object

        ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CompanyQuoteConfigInterface

    • is_purchase_order_enabled boolean
    • applicable_shipping_method integer
    • available_shipping_methods string
    • use_config_settings_shipping integer
    • shipping_fee number
    • return_item_fee number
    • return_sale_item_fee number
    • return_outlet_item_fee number
    • 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 boolean
    • stockhubwebhook_order_url string
    • stockhubwebhook_invoice_url string
    • stockhubwebhook_shipment_url string
    • stockhubwebhook_creditmemo_url string
    • stockhubwebhook_rma_url string
    • stockhubwebhook_apikey string
• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• 400

  400 Bad Request

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace