Web API Docs API Reference

Welcome to Planeta Envíos API Documentation.

Log in using your email and password from www.app.planetaenvios.com, to start making your shipments.

It's easy and fast, just quote, choose rate and request your shipment.

API Endpoint

https://api.planetaenvios.com/v1

Request Content-Types: application/json

Response Content-Types: application/json

Schemes: http, https

Version: 1.0

Authentication

login

Usuario

Clave

Password

header

Cotiza

Request Cotiza

POST /Cotiza

Get quotation for a shipment

SANDBOX PATH

POST /Cotiza_sandbox

Valid JSON.

Request Example

{	
	"CPOrigen":"44200",
	"PaisOrigen":"MX",
	"CPDestino":"45200",
	"PaisDestino":"MX",
	"PesoKG":1,
	"LargoCM":10,
	"AnchoCM":10,
	"AltoCM":10,
	"Seguro":0,
	"MontoSeguroPesos":0,
	"MontoAduana":0,
	"Recoleccion":1,
	"EsInternacional":0,
	"Descripcion":"Ipad",
	"CiudadR":"",
	"CiudadD":""
}

200 OK

QuotationResponse

Request processed.

401 Unauthorized

Unauthorized.

403 Forbidden

Access denied.

500

Error.

Response Example (200 OK)

{
 [
  "Resultado":{
	"IdProveedorServicio": "FedEx1",
	"Proveedor": "FedEx",
	"TipoServicio": "FEDEX_EXPRESS_SAVER",
	"Total": 200,
	"Recoleccion": "0.00",
	"Seguro": "0.00",
	"FechaEstimada": "01/01/0001 00:00",
	"FechaEstimadaDT": "01/01/0001T00:00:00,
	"Peso": "1.0 KG",
	"CodigoServicio": "NkVaUmIvMTR4bWF5...XVHcVE",
	"MT": "0",
	"Calificacion": "0",
   }
  ],
  "error": false,
  "mensaje": "",
}


api_key	api_key

Guia

Request Guia

POST /Guia

Create a new guide

SANDBOX PATH
POST /Guia_sandbox

Guia

Valid JSON.

Request Example

{ 
  "CodigoServicio": "NkVaUmIvMTR4bWF5...XVHcVE",
  "CalleNumR": "Nombre de la calle 123",
  "ColoniaR": "Centro",
  "CiudadR": "Zapopan",
  "EstadoR": "Jalisco",
  "NombreR": "Nombre Remitente",
  "TelefonoR": "3311223344",
  "CalleNumD": "Nombre de la calle 321",
  "ColoniaD": "Centro",
  "CiudadD": "Guadalajara",
  "EstadoD": "Jalisco",
  "NombreD": "Nombre Destinatario",
  "TelefonoD": "3344332211",
  "TaxIDR": "",
  "TaxIDD": "",
  "NumFactura": "",
  "EmpresaR": "Tu Empresa",
  "EmpresaD": "",
  "HoraRecolecion": 0,
  "DescPaisR": "MEXICO",
  "DescPaisD": "MEXICO"
}

200 OK

Request processed.

Response Example (200 OK)

{
                  
"Resultado": {
   "ExtensionData": "string",
   "NumeroGuia": "string",
   "Guia": "string",
   "Error": "string",
   "Recoleccion": "string",
  },
  "error": bool,
  "mensaje": "string"
}

Rastrea

Rastrea Guia

Get /Rastrea

Tracking

Rastrea

Valid JSON.

Request Example

{
  "Guia": "string",
  "Compania": "string"
}

200 OK

Request processed.

Response Example (200 OK)

{
  "Resultado": "string",
  "error": bool,
  "mensaje": "string"
}

Cancela

Post /Cancela

Cancel a guide

Cancela

Valid JSON.

Request Example

{
  "Guia": "string"
}

200 OK

Request processed.

Response Example (200 OK)

{
  "Resultado": "string",
  "error": bool,
  "mensaje": "string"
}

GuiasSobrepeso

GET /GuiasSobrepeso

Get guide with overheight

GuiasSobrepeso

Valid JSON.

Request Example

{ 
}

200 OK

Request processed.

Response Example (200 OK)

{
                  
"Resultado": {[
   "guia": "string",
   "pesoComprado": int,
   "pesoReal": int,
   "costoKgExtra": int,
   "total": int,
   "fecha": dateTime,
  ]},
  "error": bool,
  "mensaje": "string"
}

Reembolsos

GET /Reembolsos

Get guides refunds

Reembolsos

Valid JSON.

Request Example

{ 
}

200 OK

Request processed.

Response Example (200 OK)

{
                  
"Resultado": {[
   "guia": "string",
   "reembolso": int,
   "descripcion": "string",
   "fecha": dateTime,
  ]},
  "error": bool,
  "mensaje": "string"
}

Documentation by Mantarraya