Gestión de ordenes y envíos

Una vez que se cree una orden de marketplace, se creará, luego de unos segundos y en forma automática, un envío en Zipnova a partir de ella.

Listar órdenes

get

/orders

Retorna un listado paginado de órdenes de la cuenta autenticada. Si el usuario autenticado es propietario de un marketplace, también se incluyen los órdenes de todas las cuentas vendedoras asociadas, filtrados a ese marketplace.

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 una cuenta vendedora específica. Debe ser una cuenta a la que el usuario autenticado tenga acceso.

Example: 1

marketplacestringOpcional

Filtrar por código de marketplace (ej. meli, shopify).

Example: meli

pageintegerOpcional

Número de página para la paginación (50 órdenes por página).

Example: 1

Respuestas

200

Listado paginado de órdenes

application/json

401

No autenticado.

403

Permisos insuficientes. Se requiere el permiso orders.view.

get/orders

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

{
  "data": [
    {
      "id": 12345,
      "account_id": 1,
      "channel": {
        "type": "marketplace",
        "marketplace": "meli",
        "created_at": "2024-01-15T10:00:00-03:00",
        "paid_at": "2024-01-15T10:05:00-03:00",
        "data": {}
      },
      "completed_at": "2024-01-15T10:10:00-03:00",
      "shipment_requested_at": "2024-01-15T10:15:00-03:00",
      "saved_origin_id": 5,
      "logistic_type": "cross_docking",
      "carrier_id": 3,
      "service_type_id": 7,
      "destination": {
        "id": 2971,
        "name": "Zipnova - Garín",
        "street": "Tierra del Fuego",
        "street_number": "2498",
        "street_extras": "Nave 3 - GoodPark",
        "zipcode": "1619",
        "phone": "+54 9 11 1234-5678",
        "email": "operaciones@zippin.com.ar",
        "document": "30-70835592-1",
        "city": {
          "id": 815,
          "name": "Garín"
        },
        "state": {
          "id": "AR-B",
          "name": "Buenos Aires"
        },
        "country": {
          "id": "AR",
          "name": "Argentina"
        },
        "location_latitude": -34.4250302,
        "location_longitude": -58.7320621,
        "location_type": null,
        "location_metadata": null,
        "is_accurate": null,
        "created_at": "2020-12-01T18:31:01.000000Z",
        "updated_at": "2020-12-01T18:31:01.000000Z",
        "confirmed_at": null
      },
      "items": [
        {
          "id": 1001,
          "qty": 2,
          "unit_price": 2500,
          "currency": "ARS",
          "product_id": 88,
          "data": {
            "sku": "SKU-001",
            "name": "Producto A"
          }
        }
      ],
      "total_paid_amount": 5000,
      "total_shipping_paid_amount": 0,
      "currency": "ARS",
      "tags": [
        "text"
      ],
      "shipments": [
        {
          "id": 9001,
          "external_id": "OCA-000123",
          "tracking_id": "ZP-9001",
          "status": "ready_to_ship",
          "tracking_url": "https://track.zipnova.com.ar/ZP-9001"
        }
      ],
      "created_at": "2024-01-15T10:00:00-03:00",
      "updated_at": "2024-01-15T10:20:00-03:00"
    }
  ],
  "links": {
    "first": "https://api.zipnova.com.ar/v2/orders?page=1",
    "last": "https://api.zipnova.com.ar/v2/orders?page=5",
    "prev": null,
    "next": "https://api.zipnova.com.ar/v2/orders?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 50,
    "to": 50,
    "total": 237
  }
}

Obtener órden

get

/orders/{order}

Retorna el detalle completo de un órden específico. El usuario autenticado debe tener acceso a la cuenta propietaria de la órden.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

orderintegerRequerido

ID de órden en Zipnova

Example: 12345

Respuestas

200

Detalle de la órden

application/json

Representa un pedido de marketplace y sus detalles de envío asociados.

idintegerOpcional

Identificador único del pedido

Example: 12345

account_idintegerOpcional

ID de la cuenta vendedora propietaria del pedido

Example: 1

completed_atstring · date-time · nullableOpcional

Fecha y hora en que el pedido fue marcado como completado (pago confirmado)

Example: 2024-01-15T10:10:00-03:00

shipment_requested_atstring · date-time · nullableOpcional

Fecha y hora en que se solicitó la creación del envío para este pedido

Example: 2024-01-15T10:15:00-03:00

saved_origin_idinteger · nullableOpcional

ID de la dirección del libro de direcciones utilizada como origen del envío

Example: 5

logistic_typestring · nullableOpcional

Código del tipo logístico (ej. cross_docking, fulfillment)

Example: cross_docking

carrier_idinteger · nullableOpcional

ID del transportista asignado a este pedido

Example: 3

service_type_idinteger · nullableOpcional

ID del tipo de servicio asignado a este pedido

Example: 7

destinationone of · nullableOpcional

Dirección de destino de entrega

total_paid_amountnumber · nullableOpcional

Monto total pagado por el comprador

Example: 5000

total_shipping_paid_amountnumber · nullableOpcional

Monto de envío pagado por el comprador

Example: 0

currencystring · nullableOpcional

Código de moneda del pedido (ISO 4217)

Example: ARS

tagsstring[] · nullableOpcional

Etiquetas asociadas al pedido

created_atstring · date-timeOpcional

Fecha y hora en que se creó el registro en Zipnova

Example: 2024-01-15T10:00:00-03:00

updated_atstring · date-timeOpcional

Fecha y hora de la última actualización del registro

Example: 2024-01-15T10:20:00-03:00

401

No autenticado.

403

El usuario autenticado no tiene acceso a este órden.

404

Pedido no encontrado.

get/orders/{order}

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

{
  "id": 12345,
  "account_id": 1,
  "channel": {
    "type": "marketplace",
    "marketplace": "meli",
    "created_at": "2024-01-15T10:00:00-03:00",
    "paid_at": "2024-01-15T10:05:00-03:00",
    "data": {}
  },
  "completed_at": "2024-01-15T10:10:00-03:00",
  "shipment_requested_at": "2024-01-15T10:15:00-03:00",
  "saved_origin_id": 5,
  "logistic_type": "cross_docking",
  "carrier_id": 3,
  "service_type_id": 7,
  "destination": {
    "id": 2971,
    "name": "Zipnova - Garín",
    "street": "Tierra del Fuego",
    "street_number": "2498",
    "street_extras": "Nave 3 - GoodPark",
    "zipcode": "1619",
    "phone": "+54 9 11 1234-5678",
    "email": "operaciones@zippin.com.ar",
    "document": "30-70835592-1",
    "city": {
      "id": 815,
      "name": "Garín"
    },
    "state": {
      "id": "AR-B",
      "name": "Buenos Aires"
    },
    "country": {
      "id": "AR",
      "name": "Argentina"
    },
    "location_latitude": -34.4250302,
    "location_longitude": -58.7320621,
    "location_type": null,
    "location_metadata": null,
    "is_accurate": null,
    "created_at": "2020-12-01T18:31:01.000000Z",
    "updated_at": "2020-12-01T18:31:01.000000Z",
    "confirmed_at": null
  },
  "items": [
    {
      "id": 1001,
      "qty": 2,
      "unit_price": 2500,
      "currency": "ARS",
      "product_id": 88,
      "data": {
        "sku": "SKU-001",
        "name": "Producto A"
      }
    }
  ],
  "total_paid_amount": 5000,
  "total_shipping_paid_amount": 0,
  "currency": "ARS",
  "tags": [
    "text"
  ],
  "shipments": [
    {
      "id": 9001,
      "external_id": "OCA-000123",
      "tracking_id": "ZP-9001",
      "status": "ready_to_ship",
      "tracking_url": "https://track.zipnova.com.ar/ZP-9001"
    }
  ],
  "created_at": "2024-01-15T10:00:00-03:00",
  "updated_at": "2024-01-15T10:20:00-03:00"
}

Listar envíos de la órden

get

/orders/{order}/shipments

Retorna un listado paginado de envíos asociados a un órden específico (50 por página). Requiere los permisos orders.view y shipments.show.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

orderintegerRequerido

ID de la órden en Zipnova

Example: 12345

Parámetros de consulta

pageintegerOpcional

Número de página para la paginación (50 envíos por página).

Example: 1

Respuestas

200

Listado paginado de envíos de la órden

application/json

idintegerOpcional

ID único del envío

Example: 1042

external_idstring · nullableOpcional

Identificador externo del envío (e.g. número de orden del cliente)

Example: ORDER-9821

delivery_idstring · nullableOpcional

Número de remito asignado por el transportista

Example: R-00012345

carrier_tracking_idstring · nullableOpcional

Identificador de seguimiento público del transportista

Example: TRACKING-ABC123

carrier_tracking_id_altstring · nullableOpcional

Identificador de seguimiento alternativo del transportista

Example: TRACKING-XYZ456

created_atstring · date-timeOpcional

Fecha y hora de creación del envío (ISO 8601)

Example: 2024-08-15T10:30:00+00:00

account_idintegerOpcional

ID de la cuenta propietaria del envío

Example: 7

parent_shipment_idinteger · nullableOpcional

ID del envío padre. Presente cuando este envío es una devolución o reenvío

Example: 1040

logistic_typestringOpcional

Tipo de logística del envío (e.g. crossdock, carrier_dropoff, xd_dropoff, self_service)

Example: crossdock

service_typestringOpcional

Código del tipo de servicio (e.g. standard, express, pickup_point)

Example: standard

statusstringOpcional

Código de estado actual del envío (e.g. new, in_transit, delivered)

Example: in_transit

status_namestringOpcional

Nombre legible del estado actual

Example: En camino

substatus_codestring · nullableOpcional

Código del subestado actual del envío, si aplica

Example: ok

substatus_namestring · nullableOpcional

Nombre legible del subestado actual, si aplica

Example: Ok

trackingstring · nullableOpcional

URL de seguimiento público del envío en la plataforma

Example: https://app.zipnova.com/tracking/1042

tracking_externalstring · nullableOpcional

URL de seguimiento en el sitio web del transportista

Example: https://carrier.com/track?id=ABC123

return_instructionsstring · nullableOpcional

URL con instrucciones de devolución. Solo presente en envíos de tipo reverse logistics

Example: https://app.zipnova.com/return/abc123xyz

declared_valuenumber · floatOpcional

Valor declarado del contenido del envío en la moneda local

Example: 1500

pricenumber · floatOpcional

Costo del envío sin impuestos

Example: 320.5

price_incl_taxnumber · floatOpcional

Costo del envío con impuestos incluidos

Example: 387.8

total_weightintegerOpcional

Peso total del envío en gramos

Example: 1200

total_volumeintegerOpcional

Volumen total del envío en centímetros cúbicos (cm³)

Example: 8000

tagsstring[]Opcional

Etiquetas asociadas al envío

sourcestring · nullableOpcional

Fuente u origen de creación del envío (e.g. nombre del canal o integración)

Example: shopify

401

No autenticado.

403

El usuario autenticado no tiene acceso a este órden o le falta el permiso shipments.show.

404

Pedido no encontrado.

get/orders/{order}/shipments

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

{
  "id": 1042,
  "external_id": "ORDER-9821",
  "delivery_id": "R-00012345",
  "carrier_tracking_id": "TRACKING-ABC123",
  "carrier_tracking_id_alt": "TRACKING-XYZ456",
  "created_at": "2024-08-15T10:30:00+00:00",
  "delivery_time": {
    "estimated_delivery": "2024-08-18T23:59:59+00:00",
    "dropoff_deadline_at": "2024-08-16T15:00:00+00:00",
    "times": {
      "preparation": "P2D",
      "crossdocking": "P1D",
      "carrier": "P5D",
      "total": "P8D"
    }
  },
  "account_id": 7,
  "parent_shipment_id": 1040,
  "logistic_type": "crossdock",
  "service_type": "standard",
  "carrier": {
    "id": 3,
    "name": "Andreani",
    "logo": "https://cdn.zipnova.com/carriers/andreani.png"
  },
  "status": "in_transit",
  "status_name": "En camino",
  "substatus_code": "ok",
  "substatus_name": "Ok",
  "tracking": "https://app.zipnova.com/tracking/1042",
  "tracking_external": "https://carrier.com/track?id=ABC123",
  "return_instructions": "https://app.zipnova.com/return/abc123xyz",
  "destination": {
    "name": "Juan Pérez",
    "document": "20-12345678-5",
    "street": "Av. Corrientes",
    "street_number": "1234",
    "street_extras": "Piso 3, Dto B",
    "city": "Buenos Aires",
    "state": "Buenos Aires",
    "zipcode": "C1043",
    "phone": "+5491112345678",
    "email": "juan@example.com",
    "pickup_point": {
      "id": 55,
      "name": "Sucursal Palermo",
      "geolocation": {
        "lat": -34.5907,
        "lng": -58.4239
      }
    }
  },
  "origin": {
    "id": 12,
    "name": "Depósito Central",
    "document": "30-71234567-0",
    "street": "Av. San Martín",
    "street_number": "500",
    "street_extras": null,
    "city": "Córdoba",
    "state": "Córdoba",
    "zipcode": "X5000",
    "phone": "+5493512345678",
    "email": "deposito@empresa.com",
    "is_dropshipping": false,
    "supplier": {
      "name": "Proveedor XYZ"
    }
  },
  "declared_value": 1500,
  "price": 320.5,
  "price_incl_tax": 387.8,
  "total_weight": 1200,
  "total_volume": 8000,
  "packages": [
    {
      "id": 2001,
      "label_code": "LP-00099",
      "sku_id": null,
      "weight": 1200,
      "height": 200,
      "width": 300,
      "length": 400,
      "volume": 24000,
      "description_1": "Ropa deportiva",
      "description_2": null,
      "description_3": null,
      "classification": {
        "id": 1,
        "name": "General"
      },
      "tax_class_code": "IVA21",
      "label_elements": [
        {
          "id": "zipnova_label_code",
          "type": "barcode",
          "format": "code128a",
          "value": "LP-00099"
        }
      ],
      "container": {
        "id": 5,
        "description": "Caja chica",
        "outer_width": 320,
        "outer_height": 220,
        "outer_length": 420,
        "inner_width": 310,
        "inner_length": 410,
        "inner_height": 210,
        "max_weight": 5000,
        "empty_weight": 200
      },
      "items": [
        {
          "id": 3001,
          "sku": {
            "sku": "SKU-001",
            "sku_id": 88,
            "internal_sku": "INT-001",
            "name": "Remera Azul Talle M",
            "barcode": "7791234567890"
          },
          "description": "Remera Azul Talle M",
          "tax_class_code": "IVA21",
          "must_keep_vertical": false,
          "weight": 300,
          "width": 100,
          "length": 150,
          "height": 20,
          "pos_x": 0,
          "pos_y": 0,
          "pos_z": 0
        }
      ]
    }
  ],
  "tags": [],
  "related_shipments": [
    {
      "type": "child",
      "relationship": "return",
      "shipment_id": 1043
    }
  ],
  "source": "shopify",
  "marketplace": {
    "code": "meli",
    "name": "MercadoLibre"
  },
  "order": {
    "id": 500,
    "channel": "meli",
    "channel_created_at": "2024-08-14T08:00:00+00:00",
    "channel_relations": [
      {
        "type": "order",
        "id": "2000009876543210"
      }
    ]
  },
  "fulfillment_order": {
    "id": 200,
    "status_id": 3,
    "external_id": "FO-88991",
    "items": [
      {
        "sku_id": 88,
        "qty": 2,
        "lot_numbers": [
          "text"
        ],
        "serial_numbers": [
          "text"
        ]
      }
    ]
  },
  "rescue": {
    "requested_at": "2024-08-16T09:41:03+00:00"
  }
}

AnteriorCotización y creación de ordenes SiguienteServidor MCP de Zipnova Envíos

Última actualización hace 3 meses