Cotizador

REST Rating API

Cotizador

Permite cotizar un envío para un origen y destino. Para mayor información de los campos seleccionar Descargar PDF.

Probar

Solicitud

URL de solicitud

Parámetros de solicitud

  • string

Encabezados de solicitud

  • (opcional)
    string
    Tipo de medio del cuerpo enviado a la API.
  • string
    Clave de suscripción que proporciona acceso a esta API. Se encuentra en su perfil de .

Cuerpo de la solicitud

  • string (4)
    obligatorio
    Código de la cobertura de origen, obtenido de la API Consultar Coberturas
  • string (4)
    obligatorio
    Código de la cobertura de destino, obtenido de la API Consultar Coberturas
  • objeto
    obligatorio
    Información del paquete que se va a enviar
  • numeric (10,2)
    obligatorio
    Peso del paquete en kilogramos
  • integer
    obligatorio
    Alto del paquete en centímetros
  • integer
    obligatorio
    Ancho del paquete en centímetros
  • integer
    obligatorio
    Largo del paquete en centímetros
  • integer
    obligatorio
    Tipo de producto a enviar; 1 = Documento, 3 = Encomienda
  • integer
    opcional
    Valor declarado del paquete
  • integer
    opcional
    Servicios de entrega a consultar; 0 = Todos, 1 = Prioritarios, 2 = No prioritarios, 3 = De devolución

{
"originCountyCode":	"PROV",
"destinationCountyCode": "LCON",
"package": 
{
	"weight":	"1.5",
	"height":	"10",
	"width":	"10",
	"length":	"10"
},
"productType": 3,
"contentType": 1,
"declaredWorth": "15000",
"deliveryTime":	0
}
{
  "type": "object",
  "properties": {
    "originCountyCode": {
      "type": "string"
    },
    "destinationCountyCode": {
      "type": "string"
    },
    "package": {
      "type": "object",
      "properties": {
        "weight": {
          "type": "string"
        },
        "height": {
          "type": "string"
        },
        "width": {
          "type": "string"
        },
        "length": {
          "type": "string"
        }
      }
    },
    "productType": {
      "format": "int32",
      "type": "integer"
    },
    "contentType": {
      "format": "int32",
      "type": "integer"
    },
    "declaredWorth": {
      "type": "string"
    },
    "deliveryTime": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": "{\n\"originCountyCode\":\t\"LAFL\",\n\"destinationCountyCode\": \"ARIC\",\n\"package\": \n{\n\t\"weight\":\t\"1.5\",\n\t\"height\":\t\"10\",\n\t\"width\":\t\"10\",\n\t\"length\":\t\"10\"\n},\n\"productType\": 1,\n\"contentType\": 1,\n\"declaredWorth\": \"15000\",\n\"deliveryTime\":\t2\n}"
}

Respuestas

200 OK

Cuerpo de la respuesta

  • objeto
  • objeto
    Servicios de entrega disponibles
  • integer
    Código del servicio disponible; 3 = Día hábil siguiente (DHS), 4 = Día hábil subsiguiente (DHSS), 5 = Tercer día hábil (3DH)
  • string (100)
    Descripción del servicio
  • string (10)
    Indica si se utilizó el peso volumétrico para calcular el peso.
  • string (10)
    Peso final con el cual se valorizó
  • string (10)
    Valor en pesos del servicio de entrega
  • string (100)
    Condiciones adicionales del servicio
  • integer
    tipo de tiempo de entrega
  • objeto
    Servicios adicionales ofrecidos
  • integer
    Código de resultado
  • string (max)
    Descripción del resultado
  • string (max)
    Descripción del error presentado en caso que aplique.

Representaciones

{
  "data": {
    "courierServiceOptions": [
      {
        "serviceTypeCode": 3,
        "serviceDescription": "DIA HABIL SIGUIENTE",
        "didUseVolumetricWeight": false,
        "finalWeight": "1.00",
        "serviceValue": "8042",
        "conditions": "",
        "deliveryType": 2,
        "additionalServices": []
      }
    ]
  },
  "statusCode": 0,
  "statusDescription": "OK",
  "errors": null
}

400 Bad Request

Representaciones

{
  "statusCode": 90,
  "statusDescription": "El JSON de entrada no es válido",
  "errors": [
    "Unterminated string. Expected delimiter: \". Path 'declaredWorth', line 15, position 1."
  ]
}

500 Internal Server Error

Representaciones

{
  "milliseconds": 0,
  "statusCode": 0,
  "statusDescription": "string",
  "errors": [
    "string"
  ]
}

Ejemplos de código

@ECHO OFF

curl -v -X POST "https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('testservices.wschilexpress.com')
    conn.request("POST", "/rating/api/v{version}/rates/courier?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('testservices.wschilexpress.com')
    conn.request("POST", "/rating/api/v{version}/rates/courier?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://testservices.wschilexpress.com/rating/api/v{version}/rates/courier')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body