Gestión de Cuentas

Listar cuentas

get

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts

Obtiene la lista paginada de cuentas accesibles por el usuario autenticado.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Respuestas

200

Lista paginada de cuentas

application/json

linksobjectOpcional

metaobjectOpcional

get

/accounts

HTTPcURLJavaScriptPython

GET /v2/accounts HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

200

Lista paginada de cuentas

{
  "data": [
    {
      "id": 1,
      "name": "Mi Empresa SA",
      "logo": "https://cdn.zipnova.com/logos/123.png",
      "company_name": "Mi Empresa Sociedad Anónima",
      "address": {
        "address": "Av. Corrientes 1234",
        "city": {
          "id": 15,
          "name": "Buenos Aires"
        },
        "state": "Buenos Aires",
        "zipcode": "C1043"
      },
      "national_tax_id": {
        "number": "30-12345678-9",
        "type": "CUIT"
      },
      "state_tax_id": null,
      "tax_category": "Responsable Inscripto",
      "email": "[email protected]",
      "phone": "1145678901",
      "contacts": {
        "operations": {
          "name": "text",
          "email": "text",
          "phone": "text"
        },
        "administrative": {
          "name": "text",
          "email": "text",
          "phone": "text"
        }
      }
    }
  ],
  "links": {},
  "meta": {}
}

Obtener una cuenta

get

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{id}

Obtiene el detalle de una cuenta específica.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

idintegerRequerido

ID de la cuenta

Respuestas

200

Detalle de la cuenta

application/json

idintegerOpcionalExample: 1

namestringOpcionalExample: Mi Empresa SA

logostring · nullableOpcional

URL del logo

Example: https://cdn.zipnova.com/logos/123.png

company_namestringOpcionalExample: Mi Empresa Sociedad Anónima

state_tax_idstring · nullableOpcional

tax_categorystringOpcionalExample: Responsable Inscripto

emailstring · emailOpcionalExample: [email protected]

phonestring · nullableOpcionalExample: 1145678901

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

get

/accounts/{id}

HTTPcURLJavaScriptPython

GET /v2/accounts/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "name": "Mi Empresa SA",
  "logo": "https://cdn.zipnova.com/logos/123.png",
  "company_name": "Mi Empresa Sociedad Anónima",
  "address": {
    "address": "Av. Corrientes 1234",
    "city": {
      "id": 15,
      "name": "Buenos Aires"
    },
    "state": "Buenos Aires",
    "zipcode": "C1043"
  },
  "national_tax_id": {
    "number": "30-12345678-9",
    "type": "CUIT"
  },
  "state_tax_id": null,
  "tax_category": "Responsable Inscripto",
  "email": "[email protected]",
  "phone": "1145678901",
  "contacts": {
    "operations": {
      "name": "text",
      "email": "text",
      "phone": "text"
    },
    "administrative": {
      "name": "text",
      "email": "text",
      "phone": "text"
    }
  }
}

Actualizar cuenta

put

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{id}

Actualiza los datos de una cuenta existente.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

idintegerRequerido

ID de la cuenta

Cuerpo

application/json

namestringOpcional

Nombre de la cuenta

Example: Mi Empresa SA

emailstring · emailOpcional

Email principal

Example: [email protected]

phonestringOpcional

Teléfono

Example: 1145678901

logostring · urlOpcional

URL pública del logo (se descarga y almacena)

Example: https://cdn.empresa.com/logo.png

websitestring · urlOpcional

Sitio web

Example: https://empresa.com

Respuestas

200

Cuenta actualizada exitosamente

application/json

idintegerOpcionalExample: 1

namestringOpcionalExample: Mi Empresa SA

logostring · nullableOpcional

URL del logo

Example: https://cdn.zipnova.com/logos/123.png

company_namestringOpcionalExample: Mi Empresa Sociedad Anónima

state_tax_idstring · nullableOpcional

tax_categorystringOpcionalExample: Responsable Inscripto

emailstring · emailOpcionalExample: [email protected]

phonestring · nullableOpcionalExample: 1145678901

400

Datos inválidos

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

500

Error al actualizar la cuenta

put

/accounts/{id}

HTTPcURLJavaScriptPython

PUT /v2/accounts/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 450

{
  "name": "Mi Empresa SA",
  "email": "[email protected]",
  "phone": "1145678901",
  "logo": "https://cdn.empresa.com/logo.png",
  "website": "https://empresa.com",
  "address": {
    "address": "Av. Corrientes 5678",
    "city": "Buenos Aires",
    "state": "Buenos Aires",
    "zipcode": "C1043"
  },
  "contacts": {
    "operations": {
      "name": "Juan Pérez",
      "email": "[email protected]",
      "phone": "1145678901"
    },
    "administrative": {
      "name": "María García",
      "email": "[email protected]",
      "phone": "1145678902"
    }
  }
}

{
  "id": 1,
  "name": "Mi Empresa SA",
  "logo": "https://cdn.zipnova.com/logos/123.png",
  "company_name": "Mi Empresa Sociedad Anónima",
  "address": {
    "address": "Av. Corrientes 1234",
    "city": {
      "id": 15,
      "name": "Buenos Aires"
    },
    "state": "Buenos Aires",
    "zipcode": "C1043"
  },
  "national_tax_id": {
    "number": "30-12345678-9",
    "type": "CUIT"
  },
  "state_tax_id": null,
  "tax_category": "Responsable Inscripto",
  "email": "[email protected]",
  "phone": "1145678901",
  "contacts": {
    "operations": {
      "name": "text",
      "email": "text",
      "phone": "text"
    },
    "administrative": {
      "name": "text",
      "email": "text",
      "phone": "text"
    }
  }
}

Obtener configuración de cuenta

get

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{id}/settings

Obtiene la configuración de notificaciones y direcciones por defecto de una cuenta.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

idintegerRequerido

ID de la cuenta

Respuestas

200

Configuración de la cuenta

application/json

account_idintegerOpcionalExample: 1

default_forward_address_idinteger · nullableOpcionalExample: 5

default_return_address_idinteger · nullableOpcionalExample: 5

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

get

/accounts/{id}/settings

HTTPcURLJavaScriptPython

GET /v2/accounts/{id}/settings HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

{
  "account_id": 1,
  "recipient_notifications": {
    "shipment_created": true,
    "shipment_shipped": true,
    "shipment_ready_for_pickup": true,
    "shipment_delivery_date_changed": false
  },
  "default_forward_address_id": 5,
  "default_return_address_id": 5
}

Actualizar configuración de cuenta

put

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{id}/settings

Actualiza las notificaciones a destinatarios y las direcciones por defecto de una cuenta.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

idintegerRequerido

ID de la cuenta

Cuerpo

application/json

default_forward_address_idintegerOpcional

ID de dirección de despacho por defecto

Example: 5

default_return_address_idintegerOpcional

ID de dirección de devolución por defecto

Example: 5

Respuestas

200

Configuración actualizada. Retorna el mismo objeto que GET /accounts/{id}/settings

application/json

account_idintegerOpcionalExample: 1

default_forward_address_idinteger · nullableOpcionalExample: 5

default_return_address_idinteger · nullableOpcionalExample: 5

400

Datos inválidos o dirección no pertenece a la cuenta

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

put

/accounts/{id}/settings

HTTPcURLJavaScriptPython

PUT /v2/accounts/{id}/settings HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "recipient_notifications": {
    "shipment_created": true,
    "shipment_shipped": true,
    "shipment_ready_for_pickup": true,
    "shipment_delivery_date_changed": false
  },
  "default_forward_address_id": 5,
  "default_return_address_id": 5
}

{
  "account_id": 1,
  "recipient_notifications": {
    "shipment_created": true,
    "shipment_shipped": true,
    "shipment_ready_for_pickup": true,
    "shipment_delivery_date_changed": false
  },
  "default_forward_address_id": 5,
  "default_return_address_id": 5
}

Resumen de facturación

get

https://api.zipnova.com.ar/v2https://api.zipnova.cl/v2https://api.zipnova.com.mx/v2

/accounts/{id}/billing

Obtiene el resumen de balance y límite de crédito de una cuenta.

Autorizaciones

basicAuthbearerAuth

AuthorizationstringRequerido

Autenticación básica HTTP utilizando token como nombre de usuario y secret como contraseña

Parámetros de ruta

idintegerRequerido

ID de la cuenta

Respuestas

200

Resumen de facturación

application/json

account_idintegerOpcionalExample: 1

balancenumberOpcional

Balance actual (deuda)

Example: 1500

credit_limitnumberOpcional

Límite de crédito

Example: 10000

credit_limit_currencystringOpcionalExample: ARS

availablenumberOpcional

Crédito disponible

Example: 8500

403

Sin acceso a esta cuenta

404

Cuenta no encontrada

get

/accounts/{id}/billing

HTTPcURLJavaScriptPython

GET /v2/accounts/{id}/billing HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

{
  "account_id": 1,
  "balance": 1500,
  "credit_limit": 10000,
  "credit_limit_currency": "ARS",
  "available": 8500
}