0.0.9

Envíos

En esta sección se explican los Endpoints que permiten gestionar los envíos de tu empresa.

Crear un Envío

Cuando se realice una compra en tu e-commerce utiliza este endpoint para indicarle a Buenvío que deseas crear un envío perteneciente a dicha compra.

const params = {
  'customer_name': 'John Doe',
  'customer_email': '[email protected]',
  'customer_phone': '(809) 555-5555',
  'is_fragile': 'true',
  'product_category': 8,
  'product_other_category': 'Juguetes',
  'address_street': 'Calle 1',
  'address_building_number': '111',
  'address_city': 2,
  'address_reference': 'Esquina Calle 2',
  'address_sector': 'Los Jardines',
  'address_representative_name': 'Jane Doe',
  'address_representative_phone': '(829) 555-5555',
};

const body = Object.keys(params)
  .map((key) => encodeURIComponent(key) + '=' + encodeURIComponent(params[key]))
  .join('&');

fetch('https://api.buenvio.com/business/v1/packages/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
    Authorization: '<YOUR_API_TOKEN>',
  },
  mode: 'cors',
  body: body,
})
  .then((response) => {
    return response.json();
  })
  .then((data) => {
    console.log(data);
  });
# Requiere usar la dependencia https://requests.readthedocs.io/en/master/

import requests

response = requests.post(
    'https://api.buenvio.com/business/v1/packages/', 
    headers={
        'Authorization': '<YOUR_API_TOKEN>'
    },
    data={
        'customer_name': 'John Doe',
        'customer_email': '[email protected]',
        'customer_phone': '(809) 555-5555',
        'is_fragile': 'true',
        'product_category': 8,
        'product_other_category': 'Juguetes',
        'address_street': 'Calle 1',
        'address_building_number': '111',
        'address_city': 2,
        'address_reference': 'Esquina Calle 2',
        'address_sector': 'Los Jardines',
        'address_representative_name': 'Jane Doe',
        'address_representative_phone': '(829) 555-5555'
    }
)

print(str(response.text)
// Requiere usar la dependencia http://docs.guzzlephp.org/

$client = new GuzzleHttp\Client();

$response = $client->request(
    'POST', 
    'https://api.buenvio.com/business/v1/packages/',
    [
        'headers' => [
            'Authorization' => '<YOUR_API_TOKEN>'
        ],
        'form_params' => [
            'customer_name' => 'John Doe',
            'customer_email' => '[email protected]',
            'customer_phone' => '(809) 555-5555',
            'is_fragile' => 'true',
            'product_category' => 8,
            'product_other_category' => 'Juguetes',
            'address_street' => 'Calle 1',
            'address_building_number' => '111',
            'address_city' => 2,
            'address_reference' => 'Esquina Calle 2',
            'address_sector' => 'Los Jardines',
            'address_representative_name' => 'Jane Doe',
            'address_representative_phone' => '(829) 555-5555',
        ]
    ]
);

$data = json_decode($response->getBody());

var_dump($data);
$response = wp_remote_post(
    'https://api.buenvio.com/business/v1/packages/', 
    [
        'method' => 'POST',
        'headers' => [
            'Authorization' => '<YOUR_API_TOKEN>'        
        ],
        'body' => [
            'customer_name' => 'John Doe',
            'customer_email' => '[email protected]',
            'customer_phone' => '(809) 555-5555',
            'is_fragile' => 'true',
            'product_category' => 8,
            'product_other_category' => 'Juguetes',
            'address_street' => 'Calle 1',
            'address_building_number' => '111',
            'address_city' => 2,
            'address_reference' => 'Esquina Calle 2',
            'address_sector' => 'Los Jardines',
            'address_representative_name' => 'Jane Doe',
            'address_representative_phone' => '(829) 555-5555',
        ]
    ]
);

if (is_wp_error($response)) {
    $error_message = $response->get_error_message();
    var_dump($error_message);
} else {
    var_dump($response);
}
// Requiere usar la dependencia https://pub.dev/packages/http/

import 'package:http/http.dart' as http;

http.post(
    'https://api.buenvio.com/business/v1/packages/',
    headers: {
        'Authorization': '<YOUR_API_TOKEN>',
    },
    body: {
        'customer_name': 'John Doe',
        'customer_email': '[email protected]',
        'customer_phone': '(809) 555-5555',
        'is_fragile': 'true',
        'product_category': 8,
        'product_other_category': 'Juguetes',
        'address_street': 'Calle 1',
        'address_building_number': '111',
        'address_city': 2,
        'address_reference': 'Esquina Calle 2',
        'address_sector': 'Los Jardines',
        'address_representative_name': 'Jane Doe',
        'address_representative_phone': '(829) 555-5555',
    }
).then((response) {
    print(response.body);
});

Parámetros de la Petición

customer_name
Descripción Nombre del cliente
Tipo string
Validaciones required

customer_email
Descripción Email del cliente
Tipo string
Validaciones required, email

customer_phone
Descripción Teléfono del cliente
Tipo string regex con la expresión .\(\d{3}\) \d{3}-\d{4}, de forma que acepta: (809) 555-5555, (829) 555-5555, (849) 555-5555, (869) 555-5555, etc.
Validaciones required, regex:/\(\d{3}\) \d{3}-\d{4}/

is_fragile
Descripción Indica que el paquete es frágil. Los valores que acepta son 'on', 'true', '1' como verdaderos, cualquier otro valor es falso.
Tipo boolean
Validaciones required

product_category
Descripción Categoría del paquete
Tipo Category
Validaciones required, integer

product_other_category
Descripción Categoría personalizable al seleccionar categoría "Otros"
Tipo string
Validaciones required_if:product_category=8

address_street
Descripción Calle destino
Tipo string
Validaciones required

address_building_number
Descripción Número de edificio destino
Tipo string
Validaciones required

address_city
Descripción Ciudad destino
Tipo AddressCity
Validaciones required, integer

address_reference
Descripción Referencia al destino
Tipo string
Validaciones required

address_sector
Descripción Sector destino
Tipo string
Validaciones required

address_representative_name
Descripción Nombre del contacto secundario
Tipo string
Validaciones required

address_representative_phone
Descripción Teléfono del contacto secundario
Tipo string
Validaciones required

Respuesta

AtributoTipo
messagestring
okbool
package_identifierstring

Tipos Especiales de Parámetros

Category

NúmeroCategoría que representa
1Electrónicos
2Moda
3Cosméticos
4Productos de Salud
5Accesorios
6Hogar
7Documentos
8Otros

AddressCity

NúmeroCiudad que representa
1Santo Domingo
2Santiago de los Caballeros
3San Pedro De Macorís
4La Romana
5La Altagracia
6San Cristóbal
7San Francisco de Macorís
8Boca Chica - Este
9San Felipe - Puerto Plata
10Boca Chica - Oeste
11Santa Cruz de Barahona
12Baní
13San Juan de la Maguana
14Bonao
15Moca
16Azua de Compostela
17Cotuí
18Santa Cruz de El Seibo
19Jarabacoa
20Nagua
21Santa Bárbara de Samaná
22Tamboril
23Mao
24Esperanza
25Pedro Brand
26Sosúa
27Hato Mayor del Rey
28Constanza
29Villa Bisonó
30Salcedo
31Villa Altagracia
32Las Matas de Farfán
33Monte Plata
34Yamasá
35San Ignacio de Sabaneta
36San José de Las Matas
37San Antonio de Guerra
38San José de Ocoa

Rastrear un Envío

Cuando un envío ya ha sido creado y depositado en Buenvío podrás usar este endpoint para rastrear el envío y ver los distintos puntos por los que ha pasado hasta que llegue a su destino.

fetch(
    'https://api.buenvio.com/business/v1/packages/track/?package_identifier=Vxkcv-wnQ5A', 
    {
        method: 'GET',
        headers: {
            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
            'Authorization': '<YOUR_API_TOKEN>'
        },
        mode: 'cors',
    }).then(response => {
        return response.json();
    }).then(data => {
        console.log(data);
    });
# Requiere usar la dependencia https://requests.readthedocs.io/en/master/

import requests

response = requests.get(
    'https://api.buenvio.com/business/v1/packages/track/?package_identifier=Nex1C-TGkhI', 
    headers={
        'Authorization': '<YOUR_API_TOKEN>'
    }
)

print(str(response.text)
// Requiere usar la dependencia http://docs.guzzlephp.org/

$client = new GuzzleHttp\Client();

$response = $client->request(
    'POST', 
    'https://api.buenvio.com/business/v1/packages/track/?package_identifier=Nex1C-TGkhI',
    [
        'headers' => [
            'Authorization' => '<YOUR_API_TOKEN>'
        ]
    ]
);

$data = json_decode($response->getBody());

var_dump($data);
$response = wp_remote_post(
    'https://api.buenvio.com/business/v1/packages/track/?package_identifier=Nex1C-TGkhI', 
    [
        'method' => 'POST',
        'headers' => [
            'Authorization' => '<YOUR_API_TOKEN>'        
        ]
    ]
);

if (is_wp_error($response)) {
    $error_message = $response->get_error_message();
    var_dump($error_message);
} else {
    var_dump($response);
}
// Requiere usar la dependencia https://pub.dev/packages/http/

import 'package:http/http.dart' as http;

http.post(
    'https://api.buenvio.com/business/v1/packages/track/?package_identifier=Nex1C-TGkhI',
    headers: {
        'Authorization': '<YOUR_API_TOKEN>',
    }
).then((response) {
    print(response.body);
});

Parámetros de la Petición

package_identifier
Descripción Identificador del paquete
Tipo string
Validaciones required

Respuesta

AtributoTipo
messagestring
okbool
package_identifierstring
← Versión de PruebaNext →