Envíos

Para saber más sobre este tema en nuestra guía sobre Envíos.

Crear envío

post

Crea un nuevo envío

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Cuerpo

application/json

shipper_idintegerRequeridoExample: 10001

external_referencestring · máx: 50OpcionalExample: 123456

declared_valuenumberOpcionalExample: 100

requires_pickupbooleanOpcionalExample: true

service_type_idintegerOpcionalExample: 1

Respuestas

201

Envío creado

application/json

400

Error en la solicitud

401

No autorizado

403

Prohibido

404

No encontrado

422

Error de validación

post

/shipments

HTTPcURLJavaScriptPython

POST /api/v1/shipments HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1174

{
  "shipper_id": 10001,
  "external_reference": 123456,
  "declared_value": 100,
  "requires_pickup": true,
  "service_type_id": 1,
  "origin": {
    "place_id": "ChIJ7cv00DwsDogRAMDACa2m4K8",
    "name": "Juan Perez",
    "phone": 5492944412345,
    "email": "[email protected]",
    "document_number": 12345678,
    "document_type": "AR-DNI",
    "street": "Calle del Bajo",
    "street_number": 123,
    "floor": 2,
    "apartment": "B",
    "reference": "2do piso",
    "city": "Bariloche",
    "state": "Rio Negro",
    "zipcode": 8400,
    "country": "AR",
    "geo_latitude": -34.444323,
    "geo_longitude": -58.234562
  },
  "destination": {
    "place_id": "ChIJ7cv00DwsDogRAMDACa2m4K8",
    "name": "Juan Perez",
    "phone": 5492944412345,
    "email": "[email protected]",
    "document_number": 12345678,
    "document_type": "AR-DNI",
    "street": "Calle del Bajo",
    "street_number": 123,
    "floor": 2,
    "apartment": "B",
    "reference": "2do piso",
    "city": "Bariloche",
    "state": "Rio Negro",
    "zipcode": 8400,
    "country": "AR",
    "geo_latitude": -34.444323,
    "geo_longitude": -58.234562
  },
  "packages": [
    {
      "external_reference": "text",
      "description": "text",
      "label_code": "text",
      "length": 12,
      "width": 12,
      "height": 12,
      "grams": 1200,
      "un_code": 1234,
      "classification": "text",
      "is_flammable": false,
      "is_corrosive": false,
      "is_fragile": false,
      "temperature_min": 0,
      "temperature_max": 25
    }
  ]
}

{
  "id": 10,
  "ulid": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
  "external_reference": 123456,
  "control_number": 123456,
  "shipper": {
    "id": 35343,
    "name": "Suministros de Oficina SA",
    "subdomain": "suministros"
  },
  "carrier": {
    "id": 25343,
    "name": "Transporte Rex",
    "subdomain": "transporte-rex"
  },
  "status": {
    "code": "in_transit",
    "name": "En tránsito",
    "substatus": {
      "code": "in_transit",
      "name": "En tránsito"
    }
  },
  "origin": {
    "id": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
    "name": "Juan Perez"
  },
  "destination": {
    "id": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
    "name": "Juan Perez"
  },
  "packages": [
    {
      "id": 10323223,
      "label_code": "text",
      "external_reference": "text",
      "length": 12,
      "width": 12,
      "height": 12,
      "grams": 1200,
      "un_code": 1234,
      "classification": "text",
      "is_flammable": false,
      "is_corrosive": false,
      "is_fragile": false,
      "temperature_min": 0,
      "temperature_max": 25
    }
  ],
  "totals": {
    "total_packages": 3,
    "total_grams": 1200,
    "total_cm3": 10000
  },
  "declared_value": 100,
  "requires_pickup": true,
  "related_shipment_id": 100932923,
  "related_type": "return",
  "created_at": "2021-08-01T12:00:00Z",
  "label_printed_at": "2021-08-01T12:00:00Z",
  "shipped_at": "2021-08-01T12:00:00Z",
  "delivered_at": "2021-08-01T12:00:00Z",
  "finished_at": "2021-08-01T12:00:00Z",
  "updated_at": "2021-08-01T12:00:00Z"
}

Obtener envío

get

Obtiene un envío por su ID

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

idinteger · int64Requerido

ID del envío

Example: 100293023

Respuestas

200

Envío obtenido

application/json

400

Error en la solicitud

401

No autorizado

403

Prohibido

404

No encontrado

422

Error de validación

get

/shipments/{id}

HTTPcURLJavaScriptPython

GET /api/v1/shipments/{id} HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 10,
  "ulid": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
  "external_reference": 123456,
  "control_number": 123456,
  "shipper": {
    "id": 35343,
    "name": "Suministros de Oficina SA",
    "subdomain": "suministros"
  },
  "carrier": {
    "id": 25343,
    "name": "Transporte Rex",
    "subdomain": "transporte-rex"
  },
  "status": {
    "code": "in_transit",
    "name": "En tránsito",
    "substatus": {
      "code": "in_transit",
      "name": "En tránsito"
    }
  },
  "origin": {
    "id": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
    "name": "Juan Perez"
  },
  "destination": {
    "id": "01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ",
    "name": "Juan Perez"
  },
  "packages": [
    {
      "id": 10323223,
      "label_code": "text",
      "external_reference": "text",
      "length": 12,
      "width": 12,
      "height": 12,
      "grams": 1200,
      "un_code": 1234,
      "classification": "text",
      "is_flammable": false,
      "is_corrosive": false,
      "is_fragile": false,
      "temperature_min": 0,
      "temperature_max": 25
    }
  ],
  "totals": {
    "total_packages": 3,
    "total_grams": 1200,
    "total_cm3": 10000
  },
  "declared_value": 100,
  "requires_pickup": true,
  "related_shipment_id": 100932923,
  "related_type": "return",
  "created_at": "2021-08-01T12:00:00Z",
  "label_printed_at": "2021-08-01T12:00:00Z",
  "shipped_at": "2021-08-01T12:00:00Z",
  "delivered_at": "2021-08-01T12:00:00Z",
  "finished_at": "2021-08-01T12:00:00Z",
  "updated_at": "2021-08-01T12:00:00Z"
}

Seguimiento de envío

get

Obtiene el seguimiento de un envío por su ID

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

idinteger · int64Requerido

ID del envío

Example: 100293023

Respuestas

200

Seguimiento obtenido

application/json

400

Error en la solicitud

401

No autorizado

403

Prohibido

404

No encontrado

422

Error de validación

get

/shipments/{id}/tracking

HTTPcURLJavaScriptPython

GET /api/v1/shipments/{id}/tracking HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tracking": [
    {
      "status": {
        "code": "in_transit",
        "name": "En tránsito"
      },
      "subtatus": {
        "code": "in_transit",
        "name": "En tránsito"
      },
      "occurred_at": "2021-08-01T12:00:00Z",
      "comments": "El envío ha sido despachado",
      "metadata": {}
    }
  ]
}

Etiquetas de envío

get

Obtiene las etiquetas de un envío por su ID

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

idinteger · int64Requerido

ID del envío

Example: 100293023

Parámetros de consulta

formatstring · enumRequerido

Formato de etiqueta (pdf, zpl, png)

Valores posibles:

Respuestas

200

Etiquetas obtenidas

application/json

get

/shipments/{id}/documentation/labels?format={format}

HTTPcURLJavaScriptPython

GET /api/v1/shipments/{id}/documentation/labels?format={format}?format=pdf HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Etiquetas obtenidas

{
  "file": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggMjUwL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nI2TzW7bMAwF0Hf"
}

Adjuntos de envío

get

Obtiene los adjuntos de un envío por su ID

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

idinteger · int64Requerido

ID del envío

Example: 100293023

Respuestas

200

Adjuntos obtenidos

application/json

get

/shipments/{id}/attachments

HTTPcURLJavaScriptPython

GET /api/v1/shipments/{id}/attachments HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Adjuntos obtenidos

{
  "attachments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "group": "invoice",
      "name": "Factura.pdf",
      "mime_type": "application/pdf",
      "size": 1024,
      "created_at": "2021-08-01T12:00:00Z"
    }
  ]
}

Adjunto de envío

get

Obtiene un adjunto de un envío por su ID

Autorizaciones

orgToken

AuthorizationstringRequerido

Bearer authentication header of the form Bearer <token>.

Parámetros de ruta

idinteger · int64Requerido

ID del envío

Example: 100293023

attachmentstring · uuidRequerido

ID del adjunto

Example: 01E5Z6Z3ZQZ3ZQZ3ZQZ3ZQZ3ZQ

Respuestas

200

Adjunto obtenido

application/json

400

Error en la solicitud

401

No autorizado

403

Prohibido

404

No encontrado

422

Error de validación

get

/shipments/{id}/attachments/{attachment}

HTTPcURLJavaScriptPython

GET /api/v1/shipments/{id}/attachments/{attachment} HTTP/1.1
Host: demo.zippinmove.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "group": "invoice",
  "name": "Factura.pdf",
  "mime_type": "application/pdf",
  "size": 1024,
  "created_at": "2021-08-01T12:00:00Z",
  "content": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggMjUwL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nI2TzW7bMAwF0Hf"
}