Documentación API API Reference

Bienvenido a la Documentación de EnvioStar.

Inicia sesión con el correo electrónico y contraseña de seller.enviostar.com, para empezar a realizar tus envíos.

Es fácil y rápido, solo cotiza, elige tu tarifa y solicita tu envío.

API Endpoint
https://rest.enviostar.com/v1
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http, https
Version: 1.0

Autentificación

Inicio de sesión

Usuario
Correo
Clave
Password
in
header

Cotización

Request CotizaG

POST /CotizaG

Obtener cotizaciones

Validación JSON.




Campo Tipo Descripción
PesoKG Int Peso físico del paquete (Kg)
min 1, max 50
LargoCM Int Largo del paquete (cm)
min 1, max 300
AnchoCM Int Ancho del paquete (cm)
min 1, max 300
AltoCM Int Alto del paquete (cm)
min 1, max 300
Seguro Boolean Solicitud de seguro
MontoSeguroPesos Int Valor declarado del envio
min 100, max 150000
Recoleccion Boolean Solicitud de recolección
Descripción String Contenido del paquete
min 3, max 25
CPOrigen String Código postal de origen
CPDestino String Código postal de destino
PaisOrigen String Pais de origen
PaisDestino String Pais de destino
Ejemplo Request
{	
              "CPOrigen":"44200",
              "PaisOrigen":"MX",
              "CPDestino":"45200",
              "PaisDestino":"MX",
              "PesoKG":1,
              "LargoCM":10,
              "AnchoCM":10,
              "AltoCM":10,
              "Seguro":false,
              "MontoSeguroPesos":100,
              "Recoleccion":1,
              "Descripcion":"Ipad"
            }
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

              {
                "Resultado":[
                {
                  "CodigoServicio": "NkVaUmIvMTR4bWF5...XVHcVE",
                  "Proveedor": "FedEx",
                  "Servicio": "FEDEX_EXPRESS_SAVER",
                  "Precio": 200,
                  "Seguro": "0.00",
                  "FechaEstimada": "01/01/0001",
                },
                ],
                "Error": false,
                "Mensaje": "",
              }
            
Ejemplo Response (500 Error)

              {
                "Error": true,
                "Mensaje": "Mensaje del error",
              }
            

Generar Guía

Request Guia

POST /GuiaG

Generar guías

SANDBOX PATH
POST /GuiaG_sandbox

Valid JSON.




Campo Tipo Descripción
CodigoServicio String Codigo de referencia para generar una Guia
CalleR String Nombre de la calle del Remitente
min 2, max 29
NumR String Numero exterior del Remitente
min 1, max 5
ColoniaR String Colonía del Remitente
min 2, max 30
CiudadR String Ciudad del Remitente
min 2, max 14
EstadoR String Estado del Remitente
min 2, max 30
TelefonoR String Teléfono del Remitente
10 digitos
NombreR String Nombre del Remitente
min 2, max 14
ApellidoR String Apellido del Remitente
min 2, max 14
EmpresaR String Empresa del Remitente
min 0, max 28
PaisR String Pais del Remitente
min 2, max 14
CalleD String Nombre de la calle del Destinatario
min 2, max 29
NumD String Numero exterior del Destinatario
min 1, max 5
ColoniaD String Colonía del Destinatario
min 2, max 30
CiudadD String Ciudad del Destinatario
min 2, max 14
EstadoD String Estado del Destinatario
min 2, max 30
TelefonoD String Teléfono del Destinatario
10 digitos
NombreD String Nombre del Destinatario
min 2, max 14
ApellidoD String Apellido del Destinatario
min 2, max 14
EmpresaD String Empresa del Destinatario
min 0, max 28
PaisD String Pais del Destinatario
min 2, max 14
Ejemplo Request

          { 
            "CodigoServicio": "NkVaUmIvMTR4bWF5...XVHcVE",
            "CalleR": "Nombre de la calle",
            "NumR": "123",
            "ColoniaR": "Centro",
            "CiudadR": "Zapopan",
            "EstadoR": "Jalisco",
            "NombreR": "Nombre Remitente",
            "ApellidoR": "Apellido Remitente",
            "TelefonoR": "3311223344",
            "EmpresaR": "Tu Empresa",
            "CalleD": "Nombre de la calle",
            "NumD": "321",
            "ColoniaD": "Centro",
            "CiudadD": "Guadalajara",
            "EstadoD": "Jalisco",
            "NombreD": "Nombre Destinatario",
            "ApellidoD": "Apellido Destinatario",
            "TelefonoD": "3344332211",
            "EmpresaD": "",
            "Recoleccion": true,
            "FechaRecoleccion": "2020-04-13",
            "HoraRecolecion": 0,
            "PaisR": "MEXICO",
            "PaisD": "MEXICO"
          }
        
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

          {
            "Resultado": 
            {
              "NumeroGuia": "1112...5114733",
              "Guia": "PDF",
              "Recoleccion": "2001-01-01",
            },
            "Error": false,
            "Mensaje": ""
          }
        
Ejemplo Response (500 Error)

          {
            "Error": true,
            "Mensaje": "Mensaje del error",
          }
        

Estado Guía

Estado de la Guía

POST /EstadoG

Estado de la Guía

Valid JSON.




Campo Tipo Descripción
Guia String Numero de Guía
Ejemplo Request

          {
            "Guia": "305567...89199",
          }
        
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

        {
          "Resultado": "Entragado",
          "Error": false,
          "Mensaje": ""
        }
      
Ejemplo Response (500 Error)

        {
          "Error": true,
          "Mensaje": "Mensaje del error",
        }
      

Cancelación Guía

Cancelación

Post /CancelacionG

Cancelar Guía

Valid JSON.




Campo Tipo Descripción
Guia String Numero de Guía
Ejemplo Request

          {
            "Guia": "305567...89199"
          }
        
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

        {
          "Resultado":
          {
            "Guia": "305567...89199",
            "Estado": "En proceso de cancelación",
            "Consulta": true,
          },
          "Error": false,
          "Mensaje": ""
        }
      
Ejemplo Response (500 Error)

        {
          "Error": true,
          "Mensaje": "Mensaje del error",
        }
      

Monedero de la Cuenta

Monedero de la cuenta

GET /Monedero

Saldo del Monedero de la cuenta

Valid JSON.

Ejemplo Request

          {

          }
        
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

        {
          "Resultado": "1500",
          "error": false,
          "mensaje": ""
        }
      
Ejemplo Response (500 Error)

        {
          "Error": true,
          "Mensaje": "Mensaje del error",
        }
      

Guias con Sobrepeso

Guias con Sobrepeso

GET /GuiasSobrepeso

Guías con Sobrepeso

Valid JSON.

Ejemplo Request

          { 
          }
        
200 OK
QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Ejemplo Response (200 OK)

        {
          "Resultado": {[
          "Guia": "305567...89199",
          "PesoComprado": 12,
          "PesoReal": 15,
          "CostoKgExtra": 5,
          "Total": 15,
          "Fecha": "2001-01-01 00:00:00",
          ]},
          "Error": false,
          "Mensaje": ""
        }
      
Ejemplo Response (500 Error)

        {
          "Error": true,
          "Mensaje": "Mensaje del error",
        }
      

Guias con Reembolso

Reembolsos

GET /Reembolsos

Guias con Reembolsos

Valid JSON.

Request Example

          { 
          }
        
200 OK

Request processed.

Response Example (200 OK)

          {

            "Resultado": {[
            "Guia": "305567...89199",
            "Reembolso": 150,
            "Descripcion": "Devolución por guía cancelada: ",
            "Fecha": "2001-01-01 00:00:00",
            ]},
            "Error": false,
            "Mensaje": ""
          }
        
Ejemplo Response (500 Error)

          {
            "Error": true,
            "Mensaje": "Mensaje del error",
          }