Generar Cotización

POST 
/quote/create

Este endpoint permite a los usuarios obtener cotizaciones de envío de diversas paqueterías, facilitando la comparación de costos y opciones disponibles. Para utilizar este servicio, el usuario debe proporcionar el código postal de origen y destino, así como las dimensiones y el peso del paquete a enviar.

Al realizar la solicitud, el sistema procesa la información y devuelve una lista de cotizaciones de diferentes proveedores de paquetería, lo que permite al usuario: comparar tarifas, optimizar costos y adaptar envíos.

Este endpoint es una herramienta valiosa para quienes buscan una gestión eficiente de sus envíos, permitiendo una toma de decisiones informada y rápida al momento de seleccionar el servicio de paquetería más adecuado.

Request

Header Parameters

Authorization anyrequired

Token de acceso en formato Bearer. Ejemplo: Bearer "access_token"

shop_id anyrequired

Identificador único de la tienda.

application/json

Body

required

codigo_postal_origen stringrequired

Código postal de la dirección de origen

codigo_postal_destino stringrequired

Código postal de la dirección de destino

peso integerrequired

Peso del paquete en kilogramos

largo integerrequired

Largo del paquete en centímetros

ancho integerrequired

Ancho del paquete en centímetros

alto integerrequired

Alto del paquete en centímetros

dias_embarque integerrequired

Tiempo estimado para preparar el paquete antes del envío.

seguro integerrequired

Indica si el paquete está asegurado: true o false.

valor_paquete integerrequired

Se debe indicar el valor si el campo "seguro" es true. Valor de factura del paquete. En caso de que el campo "seguro" sea false, se debe indicar este campo en 0.

tipo_paquete integerrequired

Indica si es paquete o sobre: 1 para sobre y 2 para paquete

comercio_id stringrequired

Identificador único de la tienda

pedido_comercio string

Número identificador del pedido

paquetes integer

Número de paquetes

generar_recoleccion boolean

Indica si se debe generar o no una recolección. True para generar recolección, False para caso contrario.

productos

array[]

Arreglo de productos para cotizar.

Array [

descripcion_sat string

Código o clave del producto o servicio a facturar de acuerdo al SAT.

codigo_sat string

Descripción del producto o servicio a facturar de acuerdo al SAT.

peso integer

Peso del paquete en kilogramos.

largo integer

Largo del paquete en centímetros.

ancho integer

Ancho del paquete en centímetros.

alto integer

Alto del paquete en centímetros.

precio integer

Precio del paquete.

]

Responses

200

Respuesta de una petición de cotización JSON

Response Headers

application/json

Schema

Schema

success boolean

Indica el resultado de la solicitud: true o false.

message string

Mensaje que se muestra al obtener la respuesta de cotización.

result

array[]

Lista de cotizaciones dependiendo de los tipos de servicios.

Object [

id integer

Índice de la cotización.

clave string

Clave de mensajería.

comercio string

Identificador del comercio en la API T1Envios.

seguro boolean

Indica si el paquete está asegurado: true o false.

cotización object

Detalles de la cotización dependiendo de los tipos de servicios. Cada elemento contiene la información de cada mensajería.

]

Example (from schema)

{
  "success":"boolean",
  "message":"string",
  "result": [
    {
      "id": "integer",
      "clave": "string",
      "comercio": "string",
      "seguro": "boolean",
      "cotizacion": {
        "success": "boolean",
        "message": "string",
        "code_response": "integer",
        "servicios": {
          "EXPRESSDOMESTIC": {
            "servicio": "string",
            "tipo_servicio": "string",
            "total_paquetes": "integer",
            "costo_total": "float",
            "fecha_claro_entrega": "string",
            "fecha_mensajeria_entrega": "string",
            "dias_entrega": "integer",
            "negociacion_id": "integer",
            "porcentaje_negociacion": "float",
            "moneda": "string",
            "peso": "float",
            "peso_volumetrico": "float",
            "peso_unidades": "KG",
            "largo": "float",
            "ancho": "float",
            "alto": "float",
            "dimensiones": "string",
            "token": "string"
          }
        }
    }
  ]
}

Example

{
  "success":true,
  "message":"Búsqueda exitosa!",
  "result": [
    {
      "id": 1,
      "clave": "DHL",
      "comercio":"126526103",
      "seguro":false,
      "cotizacion": {
        "success":true,
        "message":"Búsqueda exitosa!",
        "code_response":200,
        "servicios": {
          "EXPRESSDOMESTIC": {
            "servicio":"EXPRESSDOMESTIC",
            "tipo_servicio":"DiaSiguiente",
            "total_paquetes":1,
            "costo_total":108.04,
            "fecha_claro_entrega":"2024-08-29",
            "fecha_mensajeria_entrega":"2024-08-26",
            "dias_entrega":3,
            "negociacion_id":1,
            "porcentaje_negociacion": 27.0,
            "moneda": "MXN",
            "peso": 1,
            "peso_volumetrico": 0.0,
            "peso_unidades": "KG",
            "largo": 1,
            "ancho": 1,
            "alto": 1,
            "dimensiones": "CM",
            "token": "Y4dAOvFz4kuHsaEUVbWcrjTiKGsG_BhyWaHJFTX8NsE"
          }
        }
    }
  ]
}

400

Bad Request

Response Headers

application/json

Schema

Schema

error

object

required

name stringrequired

message stringrequired

details

object

required

item stringrequired

id stringrequired

Example (from schema)

{
  "error": {
    "name": "string",
    "message": "string",
    "details": {
      "item": "string",
      "id": "string"
    }
  }
}

Example

{
  "error": {
    "name": "instanceFoundError",
    "message": "The specified item already exists.",
    "details": {
      "item": "collection",
      "id": "12ece9e1-2abf-4edc-8e34-de66e74114d2"
    }
  }
}

application/json; charset=utf-8

Schema

Schema

error

object

required

name stringrequired

message stringrequired

details string[]required

Example (from schema)

{
  "error": {
    "name": "string",
    "message": "string",
    "details": [
      "string"
    ]
  }
}

Example

{
  "error": {
    "name": "malformedRequestError",
    "message": "Found 1 errors with the supplied collection.",
    "details": [
      ": must have required property 'info'"
    ]
  }
}

429

Too Many Requests

Response Headers

application/json

Schema

Schema

error stringrequired
message stringrequired

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "rateLimited",
  "message": "Rate limit exceeded. Please retry after 1669048687"
}

Loading...