APIPara desarrolladores de marcas de ecommerce, marketplaces y 3PL

Una API de envíos para vendedores.

Tarifas, etiquetas con documentos aduaneros, seguimiento y webhooks, y validación de direcciones, como endpoints REST sencillos. Integre envíos de UPS, FedEx, USPS y DHL en su tienda, sus herramientas de marketplace o su sistema de almacén.

cubre
Tarifas · Etiquetas · Seguimiento · Direcciones
transportistas
UPS · FedEx · USPS · DHL
estilo
REST + JSON, webhooks
POST/rates
// solicitud de ejemplo: comparar tarifas y luego comprar una etiqueta
const rates = await ex.rates.create({
  from:   { country: 'ES', city: 'Barcelona' },
  to:     { country: 'US', city: 'Atlanta', state: 'GA' },
  parcel: { weight_oz: 8, length_in: 10, width_in: 8, height_in: 3 },
})

// comprar la más barata, documentos aduaneros incluidos
const label = await ex.labels.create({ rate: rates[0].id })
200tarifas de sus transportistas, de la más barata a la más carasolicitud de ejemplo · campos exactos en la referencia de la API

dónde encaja

Su sistema de un lado, los transportistas del otro.

Su código habla con una sola API. ExperShip se encarga de cada transportista, devuelve tarifas y etiquetas, y le envía las actualizaciones de seguimiento a medida que avanzan los envíos.

DÓNDE ESTÁ LA APIesquema

qué puede construir

Cuatro piezas para hacer envíos desde el código.

Las mismas funciones de la app web de ExperShip, disponibles por API. Use una, o conecte todo el flujo, del pedido a la puerta.

tarifas

Tarifas multitransportista

Envíe un origen, un destino y un paquete. Reciba tarifas en vivo de los transportistas de su cuenta, de la más barata a la más cara, para que su código o su checkout elija el servicio correcto.

  • Compare UPS, FedEx, USPS y DHL en una sola llamada
  • Envíos dentro de EE. UU. e internacionales hacia EE. UU.
  • Elija por precio, tiempo de entrega o sus propias reglas
TARIFAS Shopify #7323 → Philadelphiarespuesta de ejemplo
#TransportistaServicioNota
0FedExHome Deliverymás barata a tiempo
1USPSGround Advantagecomparada
2UPSGroundcomparada
3USPSPriority Mailcomparada
rates[0] es la que eligieron sus reglas
etiquetas

Etiquetas, con documentos aduaneros para envíos internacionales

Convierta la tarifa elegida en una etiqueta lista para imprimir. Para paquetes que entran a EE. UU., los documentos aduaneros vuelven en el mismo paso, así no se completa nada a mano.

  • Una etiqueta, o muchas en lote
  • Papeles de aduana junto con la etiqueta
  • La misma llamada para todos los transportistas
Pedido de Amazon · Barcelona → Atlantasolicitud de ejemplo
// las tarifas llegaron de la más barata a la más cara; comprar rates[0]
const label = await ex.labels.create({ rate: rates[0].id })

// paquete internacional: etiqueta + declaración de aduana
// UPS Worldwide Expedited · Barcelona, España → Atlanta, GA
200etiqueta lista para imprimir, documentos aduaneros incluidos
seguimiento y webhooks

Seguimiento y webhooks

Cada envío que cree se puede rastrear. Consulte su estado cuando quiera, o registre un webhook y reciba las actualizaciones de estado, en orden, a medida que avanza el paquete.

  • Actualizaciones de estado enviadas a su sistema
  • Sus registros de pedidos se mantienen al día solos
  • Úselas para avisar a los compradores a su manera
Cómo funcionan los webhooks →
ENVÍO Shopify #7323 · FedEx Home Deliveryejemplo
estado
En tránsito
transportista
FedEx
destino
Philadelphia, PA
comprador
notificado
validación de direcciones

Validación de direcciones

Revise una dirección antes de comprar la etiqueta. Detectar un error de tipeo en el checkout o en el almacén cuesta menos que un paquete devuelto o una corrección del transportista más adelante.

  • Valide en el checkout o antes de imprimir
  • Reciba una dirección corregida cuando sea posible
  • Frene las direcciones erróneas antes del envío
VERIFICACIÓN DE DIRECCIÓNejemplo
como se ingresó

1200 main st
philadelphia pa

validada

1200 Main St
Philadelphia, PA 19103

entregable · lista para etiquetar

referencia de la api

Los endpoints de un vistazo.

Un mapa en lenguaje sencillo de lo que cubre la API. Las rutas, campos y respuestas exactos están en la referencia completa de la API.

ENDPOINTS por áreailustrativo · no es la especificación
ÁreaUsted envíaUsted recibeEjemplo
TarifasOrigen, destino, tamaño y peso del paqueteTarifas de sus transportistas conectados, de la más barata a la más caraPOST /rates
EtiquetasLa tarifa que eligióUna etiqueta para imprimir, más documentos aduaneros para paquetes internacionalesex.labels.create(...)
SeguimientoUn envío que creóSu estado actual y su historialver la referencia
WebhooksUna URL de su ladoActualizaciones de estado enviadas a ella a medida que avanza cada envíover la referencia
Validación de direccionesUna direcciónSi es entregable, con una versión corregida cuando sea posiblever la referencia
¿Quiere la referencia completa? Obtenga una clave de API o pídanos acceso.Obtener una clave de API →Hable con nosotros →

webhooks

Las actualizaciones de estado llegan a usted.

En lugar de consultar a cada transportista, dele a ExperShip una URL. A medida que avanza un envío, sus actualizaciones de estado se envían a esa URL en orden, así sus pedidos, paneles y correos a compradores se mantienen al día.

  1. Registre un endpoint

    Una URL en su servidor que acepte JSON.

  2. Reciba las actualizaciones en orden

    Los cambios de estado de cada envío llegan en el orden en que ocurrieron.

  3. Actualice su sistema

    Guarde el estado en el pedido, dispare un correo al comprador o marque un problema para su equipo.

ACTUALIZACIONES DE ESTADO Shopify #7323envío de ejemplo
  1. 01
    Etiqueta creadaFedEx Home Delivery
  2. 02
    Recogido por el transportistaprimer escaneo del transportista
  3. 03
    En tránsitoavanzando por la red
  4. 04
    En repartoPhiladelphia, PA
  5. 05
    Entregadoestado final
etiquetas en lenguaje sencillo · nombres de estado exactos en la referencia de la API
su handler de webhookboceto de ejemplo
// su servidor: recibir una actualización de estado y guardarla
app.post('/shipping-updates', async (req, res) => {
  const update = req.body
  await saveShipmentStatus(update)  // su código
  res.sendStatus(200)
})

Integre los envíos a sus sistemas.

Obtenga una clave de API y empiece con tarifas y etiquetas. ¿Planea una integración más grande, o hace envíos internacionales hacia EE. UU.? Hable con nosotros primero.