Ctrlk
Zipnova.comAyudaSuscribir a novedades
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ubicaciones de cuenta

Una cuenta puede crear ubicaciones que pueden tener distintos usos. Todo parte de una dirección guardada, y sus usos incluyen:

  • Pueden ser usados como origen de envíos (o destino de devoluciones)

  • Pueden ser usados como almacenes propios de la cuenta, y poder gestionar stock de sus productos.

  • Pueden habilitarse como puntos de entrega de envíos.

Ubicaciones como orígenes de envío

A la hora de crear un envío es obligatorio indicar el origen del mismo. Los orígenes se dan de alta en la cuenta de cada vendedor.

Listar direcciones

get
/addresses

Obtiene un listado paginado de las ubicaciones de de la cuenta.

Autorizaciones
AuthorizationstringRequerido

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

Parámetros de consulta
account_idintegerOpcional

Filtrar por ID de cuenta

Respuestas
200

Lista paginada de direcciones guardadas

application/json
linksobjectOpcional
metaobjectOpcional
get/addresses
GET /v2/addresses HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*
200

Lista paginada de direcciones guardadas

{
  "data": [
    {
      "id": 1,
      "name": "Empresa SA",
      "document": "30-12345678-9",
      "street": "Av. Corrientes",
      "street_number": "1234",
      "street_extras": "Piso 3 Dpto B",
      "city": {
        "id": 15,
        "name": "Buenos Aires"
      },
      "state": {
        "id": 1,
        "name": "Buenos Aires"
      },
      "zipcode": "C1043",
      "phone": "1145678901",
      "email": "contacto@empresa.com",
      "hours": {
        "open": "09:00",
        "close": "18:00"
      },
      "use_for_shipping": 1,
      "automatic_pickup": false,
      "default_logistic_type": "crossdock",
      "logistic_types": [
        "crossdock",
        "carrier_pickup"
      ],
      "accounts": [
        {
          "id": 1,
          "name": "text",
          "options": {
            "automatic_status_change": true,
            "pickup_days": [
              "text"
            ],
            "use_preparation_time": true,
            "preparation_time": "P15D",
            "pickup_auto_schedule": 1,
            "avg_weight_manual": 1,
            "avg_weight_30d": 1
          }
        }
      ]
    }
  ],
  "links": {},
  "meta": {}
}

Obtener una dirección

get
/addresses/{id}

Obtiene el detalle de una dirección de origen por ID.

Autorizaciones
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 dirección

Respuestas
200

Detalle de la dirección

application/json
idintegerOpcionalExample: 1
namestringOpcionalExample: Empresa SA
documentstring · nullableOpcionalExample: 30-12345678-9
streetstringOpcionalExample: Av. Corrientes
street_numberstringOpcionalExample: 1234
street_extrasstring · nullableOpcionalExample: Piso 3 Dpto B
zipcodestring · nullableOpcionalExample: C1043
phonestring · nullableOpcionalExample: 1145678901
emailstring · nullableOpcionalExample: contacto@empresa.com
use_for_shippingintegerOpcional

1 = habilitada como origen de envíos, 0 = no

Example: 1
automatic_pickupbooleanOpcionalExample: false
default_logistic_typestring · nullableOpcionalExample: crossdock
logistic_typesstring[]OpcionalExample: ["crossdock","carrier_pickup"]
get/addresses/{id}
GET /v2/addresses/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Accept: */*

{
  "id": 1,
  "name": "Empresa SA",
  "document": "30-12345678-9",
  "street": "Av. Corrientes",
  "street_number": "1234",
  "street_extras": "Piso 3 Dpto B",
  "city": {
    "id": 15,
    "name": "Buenos Aires"
  },
  "state": {
    "id": 1,
    "name": "Buenos Aires"
  },
  "zipcode": "C1043",
  "phone": "1145678901",
  "email": "contacto@empresa.com",
  "hours": {
    "open": "09:00",
    "close": "18:00"
  },
  "use_for_shipping": 1,
  "automatic_pickup": false,
  "default_logistic_type": "crossdock",
  "logistic_types": [
    "crossdock",
    "carrier_pickup"
  ],
  "accounts": [
    {
      "id": 1,
      "name": "text",
      "options": {
        "automatic_status_change": true,
        "pickup_days": [
          "text"
        ],
        "use_preparation_time": true,
        "preparation_time": "P15D",
        "pickup_auto_schedule": 1,
        "avg_weight_manual": 1,
        "avg_weight_30d": 1
      }
    }
  ]
}

Crear dirección

post
/addresses

Crea una nueva dirección de origen en la libreta de contactos para una cuenta.

Autorizaciones
AuthorizationstringRequerido

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

Cuerpo
account_idintegerRequerido

ID de la cuenta

Example: 1
namestringRequerido

Nombre del contacto (máx 50)

Example: Empresa SA
documentstringRequerido

Número de documento/CUIT (máx 50)

Example: 30-12345678-9
emailstring · emailRequerido

Email (máx 150)

Example: contacto@empresa.com
phonestringRequerido

Teléfono (máx 50)

Example: 1145678901
streetstringRequerido

Calle (máx 50)

Example: Av. Corrientes
street_numberstringRequerido

Número (máx 10)

Example: 1234
street_extrasstringOpcional

Piso, depto, etc. (máx 190)

Example: Piso 3 Dpto B
city_idintegerOpcional

ID de ciudad del sistema (alternativa a city+state+zipcode)

Example: 15
citystringOpcional

Nombre de ciudad (requerido si no se envía city_id)

Example: Buenos Aires
statestringOpcional

Nombre de provincia/estado (requerido si no se envía city_id)

Example: Buenos Aires
zipcodestringRequerido

Código postal (máx 5)

Example: C1043
default_logistic_typestringOpcional

Tipo logístico por defecto. Si es xd_dropoff y queda excluido por falta de cobertura, se guarda en null

Example: crossdock
logistic_typesstring[]Opcional

Tipos logísticos habilitados para esta dirección. xd_dropoff se descarta en silencio, sin devolver error, cuando se comprueba que ningún crossdock de Zipnova cubre el origen; si la dirección no tiene coordenadas la cobertura no se puede evaluar y el tipo se conserva. La respuesta devuelve los tipos que quedaron efectivamente guardados

Example: ["crossdock","carrier_pickup"]
Respuestas
201

Dirección creada exitosamente

application/json
idintegerOpcionalExample: 1
namestringOpcionalExample: Empresa SA
documentstring · nullableOpcionalExample: 30-12345678-9
streetstringOpcionalExample: Av. Corrientes
street_numberstringOpcionalExample: 1234
street_extrasstring · nullableOpcionalExample: Piso 3 Dpto B
zipcodestring · nullableOpcionalExample: C1043
phonestring · nullableOpcionalExample: 1145678901
emailstring · nullableOpcionalExample: contacto@empresa.com
use_for_shippingintegerOpcional

1 = habilitada como origen de envíos, 0 = no

Example: 1
automatic_pickupbooleanOpcionalExample: false
default_logistic_typestring · nullableOpcionalExample: crossdock
logistic_typesstring[]OpcionalExample: ["crossdock","carrier_pickup"]
post/addresses
POST /v2/addresses HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "account_id": 1,
  "name": "Empresa SA",
  "document": "30-12345678-9",
  "email": "contacto@empresa.com",
  "phone": "1145678901",
  "street": "Av. Corrientes",
  "street_number": "1234",
  "street_extras": "Piso 3 Dpto B",
  "city_id": 15,
  "city": "Buenos Aires",
  "state": "Buenos Aires",
  "zipcode": "C1043",
  "hours": {
    "open": "09:00",
    "close": "18:00"
  },
  "default_logistic_type": "crossdock",
  "logistic_types": [
    "crossdock",
    "carrier_pickup"
  ],
  "options": {
    "automatic_pickup": false,
    "automatic_status_change": false,
    "pickup_days": [
      1,
      2,
      3,
      4,
      5
    ],
    "use_preparation_time": false,
    "preparation_time": 15,
    "use_for_shipping": true
  }
}
{
  "id": 1,
  "name": "Empresa SA",
  "document": "30-12345678-9",
  "street": "Av. Corrientes",
  "street_number": "1234",
  "street_extras": "Piso 3 Dpto B",
  "city": {
    "id": 15,
    "name": "Buenos Aires"
  },
  "state": {
    "id": 1,
    "name": "Buenos Aires"
  },
  "zipcode": "C1043",
  "phone": "1145678901",
  "email": "contacto@empresa.com",
  "hours": {
    "open": "09:00",
    "close": "18:00"
  },
  "use_for_shipping": 1,
  "automatic_pickup": false,
  "default_logistic_type": "crossdock",
  "logistic_types": [
    "crossdock",
    "carrier_pickup"
  ],
  "accounts": [
    {
      "id": 1,
      "name": "text",
      "options": {
        "automatic_status_change": true,
        "pickup_days": [
          "text"
        ],
        "use_preparation_time": true,
        "preparation_time": "P15D",
        "pickup_auto_schedule": 1,
        "avg_weight_manual": 1,
        "avg_weight_30d": 1
      }
    }
  ]
}

Actualizar una dirección

put
/addresses/{id}

Actualiza los datos de una dirección de origen. Si la dirección ya está asociada a envíos, los campos de ubicación (calle, ciudad, etc.) no pueden modificarse.

Autorizaciones
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 dirección

Cuerpo
account_idintegerRequerido

ID de la cuenta

Example: 1
namestringOpcional

Nombre del contacto (máx 50)

Example: Empresa SA
documentstringOpcional

Número de documento/CUIT (máx 50)

Example: 30-12345678-9
emailstring · emailOpcional

Email (máx 150)

Example: nuevo@empresa.com
phonestringOpcional

Teléfono (máx 50)

Example: 1145678901
streetstringOpcional

Calle — no editable si la dirección tiene envíos (máx 50)

Example: Av. Corrientes
street_numberstringOpcional

Número — no editable si la dirección tiene envíos (máx 10)

Example: 5678
street_extrasstringOpcional

Piso, depto — no editable si tiene envíos (máx 190)

Example: Piso 3
city_idintegerOpcional

ID de ciudad — no editable si tiene envíos

Example: 15
citystringOpcional

Nombre de ciudad — no editable si tiene envíos

Example: Buenos Aires
statestringOpcional

Nombre de provincia — no editable si tiene envíos

Example: Buenos Aires
zipcodestringOpcional

Código postal — no editable si tiene envíos (máx 10)

Example: C1043
default_logistic_typestringOpcional

Tipo logístico por defecto. Si es xd_dropoff y queda excluido por falta de cobertura, se guarda en null

Example: crossdock
logistic_typesstring[]Opcional

Tipos logísticos habilitados para esta dirección. xd_dropoff se descarta en silencio, sin devolver error, cuando se comprueba que ningún crossdock de Zipnova cubre el origen; si la dirección no tiene coordenadas la cobertura no se puede evaluar y el tipo se conserva. La respuesta devuelve los tipos que quedaron efectivamente guardados

Example: ["crossdock","carrier_pickup"]
Respuestas
200

Dirección actualizada exitosamente

application/json
idintegerOpcionalExample: 1
namestringOpcionalExample: Empresa SA
documentstring · nullableOpcionalExample: 30-12345678-9
streetstringOpcionalExample: Av. Corrientes
street_numberstringOpcionalExample: 1234
street_extrasstring · nullableOpcionalExample: Piso 3 Dpto B
zipcodestring · nullableOpcionalExample: C1043
phonestring · nullableOpcionalExample: 1145678901
emailstring · nullableOpcionalExample: contacto@empresa.com
use_for_shippingintegerOpcional

1 = habilitada como origen de envíos, 0 = no

Example: 1
automatic_pickupbooleanOpcionalExample: false
default_logistic_typestring · nullableOpcionalExample: crossdock
logistic_typesstring[]OpcionalExample: ["crossdock","carrier_pickup"]
put/addresses/{id}
PUT /v2/addresses/{id} HTTP/1.1
Host: api.zipnova.com.ar
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 557

{
  "account_id": 1,
  "name": "Empresa SA",
  "document": "30-12345678-9",
  "email": "nuevo@empresa.com",
  "phone": "1145678901",
  "street": "Av. Corrientes",
  "street_number": "5678",
  "street_extras": "Piso 3",
  "city_id": 15,
  "city": "Buenos Aires",
  "state": "Buenos Aires",
  "zipcode": "C1043",
  "hours": {
    "open": "09:00",
    "close": "18:00"
  },
  "default_logistic_type": "crossdock",
  "logistic_types": [
    "crossdock",
    "carrier_pickup"
  ],
  "options": {
    "automatic_pickup": false,
    "automatic_status_change": false,
    "pickup_days": [
      1,
      2,
      3,
      4,
      5
    ],
    "use_preparation_time": false,
    "preparation_time": 15,
    "use_for_shipping": true
  }
}
{
  "id": 1,
  "name": "Empresa SA",
  "document": "30-12345678-9",
  "street": "Av. Corrientes",
  "street_number": "1234",
  "street_extras": "Piso 3 Dpto B",
  "city": {
    "id": 15,
    "name": "Buenos Aires"
  },
  "state": {
    "id": 1,
    "name": "Buenos Aires"
  },
  "zipcode": "C1043",
  "phone": "1145678901",
  "email": "contacto@empresa.com",
  "hours": {
    "open": "09:00",
    "close": "18:00"
  },
  "use_for_shipping": 1,
  "automatic_pickup": false,
  "default_logistic_type": "crossdock",
  "logistic_types": [
    "crossdock",
    "carrier_pickup"
  ],
  "accounts": [
    {
      "id": 1,
      "name": "text",
      "options": {
        "automatic_status_change": true,
        "pickup_days": [
          "text"
        ],
        "use_preparation_time": true,
        "preparation_time": "P15D",
        "pickup_auto_schedule": 1,
        "avg_weight_manual": 1,
        "avg_weight_30d": 1
      }
    }
  ]
}
AnteriorGestión de Cuentas
SiguienteWebhooks

Última actualización