# Obtener un envío

## Obtener un envío

<mark style="color:green;">`POST`</mark> `https://api.rocketfy.co/api/public/shippings/get`

#### Headers

| Name          | Type   | Description                                                                                                                                                               |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | string | <p>Token que recibes del método de autenticación inicial en Primeros pasos y debe enviarse en el siguiente formato: <br><br><code>Bearer MI\_TOKEN\_DE\_ACCESO</code></p> |

#### Request Body

| Name         | Type   | Description                                                                                                                                                                                                                                                  |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| customerID   | string | <p>Identificador de la tienda que se retorna al crear una tienda en Rocketfy y que debe de estar almacenado en tu base de datos. <br><br><strong>Ejemplo:</strong> <code>testpublicapi\_1325176081</code></p>                                                |
| shipping\_id | string | <p>Identificador de la orden que se desea consultar, naturalmente es tiene una estructura hexadecimal que corresponde a un <strong>ObjectID</strong> de <strong>MongoDB</strong> <br><br><strong>Ejemplo:</strong> <code>60da23857c26053a3cec72db</code></p> |

{% tabs %}
{% tab title="200 Información del envío retornada exitosamente." %}

```javascript
{
    "_id" : "60da23857c26053a3cec72dd", //Identificador único
    "order_id" : 2, //Consecutivo del envío
    "order_drop" : false,
    "status" : "delivered", //Estado del envío, ver más abajo la tabla de estados
    "billing" : {
        "full_name" : "Alex",
        "last_name" : "Casas",
        "email" : "alexcasas@gmail.com",
        "phone" : 3208000000,
        "address" : "Calle # 43 sur - 368 este",
        "address_alt" : "San miguel la victoria",
        "cc" : 1140000009,
        "country" : "CO",
        "state" : "Cundinamarca",
        "city" : "Bogota"
    },
    "subtotal" : 94000,
    "total" : 94000,
    "products_lines" : [ 
        {
            "name" : "Mi producto estrella",
            "price" : 94000,
            "slug" : "ageless",
            "image" : null,
            "type_product" : "simple",
            "dimensions" : {
                "width" : 4,
                "height" : 4,
                "large" : 8,
                "weight" : 1
            },
            "inventory" : 5,
            "free_shipping" : true,
            "sku" : "AG-10",
            "quantity" : 1
        }
    ],
    "created_time" : 2021-06-28T14:31:17+05:00, //Fecha en ISO 8601
    "update_date" : 2021-06-29T14:31:17+05:00, //Fecha en ISO 8601
    "payment_method_key" : "cod",
    "payment_method_label" : "Paga en efectivo al recibir",
    "notes" : "Estas son las notas de un pedido",
    "free_shipping" : true,
    "shipping" : {
        "id": "208451414" //Número de despacho del envío,
        "guide_in_pdf": "https://rocketfy-envios-guides..."
        "courrier": {
            "name" : "Servientrega",
            "key" : "servientrega",
            "postal_code" : "11001",
            "img" : "https://fs.rocketfy.co/icons/courriers/servientrega.svg",
            "shipping_value" : 13600, //valor del envío
            "shipping_time" : "2"
        },
        "from": {
            "address" : "Carrera 69B # 32 - 11",
            "address_alt" : "Apto 201",
            "city" : {
                "name" : "Itagui",
                "postal_code" : "76001000"
            },
            "state" : {
                "name" : "Antioquia",
                "code" : "76"
            },
            "country" : "CO",
            "composed_address" : {
                "street" : "Calle 72a ",
                "street_number_one" : "28d",
                "street_number_two" : "60"
            }
        },
        "to": {
            "address" : "Calle 72a  # 28d - 60",
            "address_alt" : "Calipso, 6-101, Sorrento 2 ",
            "city" : {
                "name" : "Cali",
                "postal_code" : "76001000"
            },
            "state" : {
                "name" : "Valle",
                "code" : "76"
            },
            "country" : "CO",
            "composed_address" : {
                "street" : "Calle 72a ",
                "street_number_one" : "28d",
                "street_number_two" : "60"
            }
        }
        
    }
    
}
```

{% endtab %}

{% tab title="404 Respuesta al no encontrar el envío buscado" %}

```
{ "message": "No pudimos retornar la envío especificado"}
```

{% endtab %}
{% endtabs %}

### Estados de los envíos

A continuación estará la definición de cada uno de los estados que podría tener un envío dentro de Rocketfy, es importante a la hora de realizar la integración conocer sus nombres en clave, y desde la conexión tener en cuenta qué acciones tomarán con esta información.\
\
**Nota**: estos estados se actualizan automáticamente basado en la información de la transportadora

| Estado del envío | Descripción                                                                                                                                                     |
| :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|     `pending`    | **Estado Pendiente**, en este estado se realiza el trabajo de preparación del envío para su entrega al transportador elegido.                                   |
|    `delivered`   | **Estado Entregado**, en este estado están todos los envíos que ya fueron entregados por la transportadora elegida.                                             |
|  `shipping_new`  | **Estado En novedad**, en este estado se encuentran los envíos que presentan inconvenientes para realizar la entrega del mismo.                                 |
|    `returned`    | **Estado Devuelto**, en este estado se encuentran los envíos que fueron devueltos a la ciudad de origen y posteriormente se entregaron a la tienda que lo envió |
|    `cancelled`   | **Estado Cancelado**, en este estado se encuentran los envíos cancelados por la tienda                                                                          |
|    `completed`   | **Estado Completado**, en este estado se encuentran los envíos que ya fueron entregados y pagados a la tienda.                                                  |
