POST v1/admin/companies/insert

ADMIN - Insert a single company.

Request Information

URI Parameters

None.

Body Parameters

AdminAddCompanyRequestModel
NameDescriptionTypeAdditional information
company_name

string

None.

company_phone

string

None.

company_phone_extension

string

None.

company_cell_number

string

None.

company_email

string

None.

company_tax_office_name

string

None.

company_tax_number

string

None.

company_address_city

string

None.

company_address_district

string

None.

company_address_neighborhood

string

None.

company_address_street

string

None.

company_address_building_number

string

None.

company_address_zip_code

string

None.

company_logo

string

None.

company_web_url

string

None.

company_invoice_info

string

None.

company_approved

boolean

None.

auto_archive_shipments

Flag to enable auto archiving of old shipments (default is true)

boolean

None.

company_shipment_only_driver_show

Company shipments only show company drivers

boolean

None.

user_company_id

Company UID of the active user

string

Required

Data type: Text

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text

Request Format

application/json, text/json

Sample:
{
  "company_name": "sample string 1",
  "company_phone": "sample string 2",
  "company_phone_extension": "sample string 3",
  "company_cell_number": "sample string 4",
  "company_email": "sample string 5",
  "company_tax_office_name": "sample string 6",
  "company_tax_number": "sample string 7",
  "company_address_city": "sample string 8",
  "company_address_district": "sample string 9",
  "company_address_neighborhood": "sample string 10",
  "company_address_street": "sample string 11",
  "company_address_building_number": "sample string 12",
  "company_address_zip_code": "sample string 13",
  "company_logo": "sample string 14",
  "company_web_url": "sample string 15",
  "company_invoice_info": "sample string 16",
  "company_approved": true,
  "auto_archive_shipments": true,
  "company_shipment_only_driver_show": true,
  "user_company_id": "sample string 19",
  "user_id": "sample string 20",
  "user_signature": "sample string 21"
}

Response Information

Resource Description

ADMIN - Insert a single company.

BaseMetaResultModelOfCompanyModel
NameDescriptionTypeAdditional information
response

CompanyModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "company_id": "sample string 2",
    "company_name": "sample string 3",
    "company_phone": "sample string 4",
    "company_phone_extension": "sample string 5",
    "company_cell_number": "sample string 6",
    "company_email": "sample string 7",
    "company_tax_office_name": "sample string 8",
    "company_tax_number": "sample string 9",
    "company_address_city": "sample string 10",
    "company_address_district": "sample string 11",
    "company_address_neighborhood": "sample string 12",
    "company_address_street": "sample string 13",
    "company_address_building_number": "sample string 14",
    "company_address_zip_code": "sample string 15",
    "company_logo": "sample string 16",
    "company_web_url": "sample string 17",
    "company_invoice_info": "sample string 18",
    "company_approved": true,
    "auto_archive_shipments": true,
    "company_shipment_only_driver_show": true,
    "company_create_date": "2018-05-21T13:32:06.3502358+03:00",
    "company_type": 22,
    "company_status": 23
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}