Administration Service: /companies

/companies

PUT https://api.abitmedia.app/administration/v1/companies

Actualización de compañías

Autorizaciones

bearer: {accessToken}

Parámetros de ruta / Parámetros de consulta

Parámetros	Tipo	Requerido	Descripción
id	integer	Si	Identificador del recurso

Parámetros Formdata / Atributos objeto JSON

Parametros	Tipo	Requerido	Descripción
businessType	enum	Si	Naturaleza de la empresa las opciones pueden ser 'services' para servicios o 'goods' para bienes
identification	string	Si	Tipo de identificador dependiendo del pais. RUC/NIT/CUIT/RUT/RFC para la mayoria de paises de la región
tradeName	string	Si	Nombre público o nombre comercial para la empresa, Ejemplo Quantum Solutions
slug	string	Si	Versión amigable y corta del nombre comercial. Ejemplo quantum-solutions
legalName	string	Si	Razón social de la empresa. Ejemplo Quantum Solutions International S.A.
logo	base64 string	No	Logo de la empresa en base64
countryId	integer	Si	Id del país
stateId	integer	Si	Id del estado o provincia
cityId	integer	Si	Id de la ciudad
address	string	Si	Dirección de la empresa
email	string	Si	Email corporativo
webPage	string	No	Url de la página web corporativa de la empresa
phoneNumber	string	Si	Número de teléfono corporativo, puede ser celular o convencional
status	smallint	No	0:inactivo 1:activo 2:eliminado.
timeZoneId	string	Si	Identificador para zona horaria
economicActivityId	string	No	Identificador para actividad economica (por país)
latitude	float	No	Latitud ubicación de compañía
longitude	float	No	Longitud ubicación de compañía
observations	string	No	Observaciones de la empresa
sellerId	integer	Si	Vendedor asignado a la empresa (usuarios isAbitmedia)
isReseller	boolean	No	Se especifica si la empresa de distribuidor de algún producto Abitmedia

Ejemplos de código

JavaScript PHP Rails

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("PUT", "https://api.abitmedia.app/administration/v1/companies", false);

// Make sure you set the appropriate headers
xmlHttp.setRequestHeader("Header Key", "Header Value");

var data = "# body is your JSON/ XML/ Text/ Form Query/ etc"
xmlHttp.send(data);

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.abitmedia.app/administration/v1/companies");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 

// Make sure you set the nessary headers as a $headers array
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put")
$body = '';
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

uri = URI.parse("https://api.abitmedia.app/administration/v1/companies")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Put.new(uri.request_uri)

# Make sure you set the appropriate headers
request["header"] = "header value"

# body is your JSON/ XML/ Text/ Form Query/ etc
request.set_form_data(body)

response = http.request(request)

Respuesta

200:

application/json

{
  "success": true,
  "status": 200,
  "message": "Recurso creado exitosamente",
  "data": {
    "businessType": "services",
    "identification": "9999999999001",
    "tradeName": "Quantum Solutions",
    "slug": "quantum-solutions",
    "legalName": "Quantum Solutions International S.A.",
    "logo": "https://abitmediacompanydocs.s3.us-east-2.amazonaws.com/9999999999001.png",
    "countryId": 1,
    "stateId": 1,
    "cityId": 1,
    "address": "1234 Innovation Drive, Suite 500, Technopolis, TX, 75001",
    "email": "[email protected]",
    "webPage": "www.quantumsolutions.com",
    "phoneNumber": "+593922222222",
    "status": 1,
    "timeZoneId": 1,
    "economicActivityId": 1,
    "latitude": 0.00000001,
    "longitude": 0.00000001,
    "observations": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod",
    "sellerId": 1,
    "isReseller": false,
    "createdAt": "2024-01-01 17:50:01",
    "updateAt": "2024-01-01 17:50:01"
  }
}

422:

application/json

{
  "success": false,
  "status": 422,
  "message": "Se encontró errores de validación en el recurso enviado",
  "data": [
      {
          "field": "attributo",
          "message": "mensaje de error"
      }
  ]
}

Otras acciones de endpoint

GET POST DELETE