We Ship You

Tienda

WeShipYou
Compra productos seleccionados de vendedores WeShipYou, con fulfillment integral y garantía de envío.
Amazon
¡Compra en Amazon, la tienda más grande del mundo con la mayor variedad de productos, todo con la seguridad de WeShipYou!
eBay
Artículos nuevos y usados de vendedores en EE. UU.: compramos por ti los anuncios con “Cómpralo ahora”.
AliExpress
Millones de productos a precio de fábrica, comprados y enviados por nosotros.
Walmart
¡Compra productos de farmacia y supermercado en Walmart de forma rápida y fácil!
Shein
¡Compra los últimos productos de tendencia a los mejores precios con descuento, solo en la tienda Shein!
Temu
¡Compra los mejores productos a precios con descuento en la tienda Temu!
Shopify
Busca en miles de tiendas Shopify de EE. UU. a la vez, o pega un enlace de cualquiera de ellas.

JavaScript Required: Enable and Reload for weshipyou.com to Function Properly

We have detected that JavaScript is currently disabled in your browser. To ensure weshipyou.com works as intended, please enable JavaScript and refresh this page. JavaScript is essential for the proper functioning and optimal user experience of our website. Thank you!

Se requiere JavaScript: habilite y vuelva a cargar para que weshipyou.com funcione correctamente

Hemos detectado que JavaScript está actualmente deshabilitado en su navegador. Para garantizar que weshipyou.com funcione según lo previsto, habilite JavaScript y actualice esta página. JavaScript es esencial para el correcto funcionamiento y la óptima experiencia de usuario de nuestro sitio web. ¡Gracias!

.NoScriptForm-content{font-family:-apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;font-size:18px;line-height:24px;margin:10%;width:80%}.pg-loading-screen{position:fixed;inset:0;z-index:1000000;background:#fff}.pg-loading-inner{height:100%;width:100%;margin:0;padding:0;position:static}.pg-loading-center-outer{width:100%;height:100%;padding:0;margin:0;display:table!important;position:absolute;top:0;left:0}.pg-loading-center-middle{padding:0;margin:0;vertical-align:middle;display:table-cell!important;text-align:center}.pg-loading-logo-header{font-family:-apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,sans-serif;width:100%;text-align:center;animation:pgAnimLoading 1s cubic-bezier(.7,0,.3,1) both}.pg-loading-html{width:100%;margin-top:90px}@keyframes pgAnimLoading{from{opacity:0}}.sk-spinner-double-bounce.sk-spinner{width:40px;height:40px;position:relative;margin:0 auto}.sk-double-bounce1,.sk-double-bounce2{width:100%;height:100%;border-radius:50%;background:#dcdcdc;opacity:.6;position:absolute;top:0;left:0;animation:sk-doubleBounce 2s infinite ease-in-out}.sk-double-bounce2{animation-delay:-1s}@keyframes sk-doubleBounce{0%,100%{transform:scale(0)}50%{transform:scale(1)}}

We Ship You

Tienda

Envíos

Crea, cotiza, etiqueta, cancela y confirma tus envíos

POST/shipments/rates
GET/shipments
POST/shipments
GET/shipments/{shipmentId}
PATCH/shipments/{shipmentId}
DELETE/shipments/{shipmentId}
GET/shipments/categories
GET/shipments/country-categories
POST/shipments/labels
DELETE/shipments/labels/{trackingNumber}
POST/shipments/confirm-delivery

El objeto Envío

Un envío: qué se envía, de quién, para quién, y el estado de su etiqueta y su entrega.

Atributos

uidstringobligatorio
UID del envío. Úsalo como shipmentId.
statestringobligatorio
Estado del ciclo de vida, desde created pasando por label_created hasta delivered o cancelled.
statusTrackingstringadmite null
Último estado de rastreo del transportista, en palabras.
transactionStatestringadmite null
Estado de cobro del envío, cuando se cobró o se reembolsó.
externalReferenceCodestringadmite null
Tu propia referencia para el envío.
externalCustomerIdstringadmite null
Tu propia referencia de cliente.
externalUniqueIdstringadmite null
Tu propia referencia de idempotencia.
incotermsstringobligatorio
Quién paga los aranceles: el destinatario (DDU) o el remitente (DDP).
Valores permitidos:DDUDDP
weightUnitstringobligatorio
Unidad de weight.
Valores permitidos:gmkgozlb
dimUnitstringobligatorio
Unidad de length, width y height.
weightnumberadmite null
Peso total.
lengthnumberadmite null
Largo de la caja.
widthnumberadmite null
Ancho de la caja.
heightnumberadmite null
Alto de la caja.
totalValuenumberadmite null
Valor declarado del contenido, USD.
insuranceboolean | integer
El envío está asegurado. 1/true o 0/false.
insuranceAmountnumberadmite null
Monto asegurado, USD.
appliedCouponDiscountnumberadmite null
Descuento de cupón aplicado al precio de la etiqueta, USD.
sellerNotesstringadmite null
Notas del remitente.
buyerNotesstringadmite null
Notas del destinatario.
labelCreatedAtstring <date-time>admite null
Cuándo se compró la etiqueta.
deliveredAtstring <date-time>admite null
Cuándo el transportista entregó el envío.
cancellationReasonstringadmite null
Por qué se canceló el envío.
cancellationReasonCodestringadmite null
Código técnico del motivo de cancelación.
customsAuthorizationsobject
Documentos de aduana que exige el destino, y si el cliente todavía puede editarlos.
senderobjectadmite null
El remitente. Se incluye cuando el envío se lee solo.
Atributos anidados
- uidstring
  UID de la entrada de la libreta de direcciones.
- nicknamestringadmite null
  Tu etiqueta para la entrada.
- companyNamestringadmite null
  Nombre de la empresa.
- namestringadmite null
  Nombre completo.
- taxIdstringadmite null
  Id fiscal.
- emailstringadmite null
  Correo electrónico.
- phonestringadmite null
  Número de teléfono.
- isResidentialboolean | integer
  Dirección de entrega residencial.
- statusstring
  Estado de la entrada.
- addressobjectadmite null
  Una dirección postal tal como WeShipYou la interpretó.
  Atributos anidados
  uidstring
  UID de la dirección.
  houseNumberstringadmite null
  Número de casa o edificio.
  roadstringadmite null
  Nombre de la calle.
  unitstringadmite null
  Apartamento, oficina o unidad.
  cityobjectadmite null
  Atributos anidados
  namestring
  Nombre de la ciudad.
  stateobjectadmite null
  Atributos anidados
  namestring
  isoCodestringadmite null
  Código del estado.
  countryobjectadmite null
  Atributos anidados
  isoCodestring
  namestring
  postal_codeobjectadmite null
  Atributos anidados
  postalCodestring
recipientobjectadmite null
El destinatario. Se incluye cuando el envío se lee solo.
Atributos anidados
- uidstring
  UID de la entrada de la libreta de direcciones.
- nicknamestringadmite null
  Tu etiqueta para la entrada.
- companyNamestringadmite null
  Nombre de la empresa.
- namestringadmite null
  Nombre completo.
- taxIdstringadmite null
  Id fiscal.
- emailstringadmite null
  Correo electrónico.
- phonestringadmite null
  Número de teléfono.
- isResidentialboolean | integer
  Dirección de entrega residencial.
- statusstring
  Estado de la entrada.
- addressobjectadmite null
  Una dirección postal tal como WeShipYou la interpretó.
  Atributos anidados
  uidstring
  UID de la dirección.
  houseNumberstringadmite null
  Número de casa o edificio.
  roadstringadmite null
  Nombre de la calle.
  unitstringadmite null
  Apartamento, oficina o unidad.
  cityobjectadmite null
  Atributos anidados
  namestring
  Nombre de la ciudad.
  stateobjectadmite null
  Atributos anidados
  namestring
  isoCodestringadmite null
  Código del estado.
  countryobjectadmite null
  Atributos anidados
  isoCodestring
  namestring
  postal_codeobjectadmite null
  Atributos anidados
  postalCodestring
parcelslista de object
Los paquetes y sus artículos. Se incluyen cuando el envío se lee solo.
parcel_rateslista de Tarifa
Los servicios con los que se puede enviar este envío y sus precios. Se incluye en la respuesta de POST /shipments y PATCH /shipments/{shipmentId}; elige uno y cómpralo con POST /shipments/labels. Su totalChargePrice incluye el seguro (insuranceFee) aunque el envío no esté asegurado; consulta el objeto Tarifa.
Atributos anidados
- uidstringobligatorio
  El id de la tarifa. Envíalo como rateId a POST /shipments/labels.
- serviceobject
  El servicio de envío.
  Atributos anidados
  uidstringadmite null
  El uid del servicio.
  namestringadmite null
  El nombre del servicio.
  umbrellaNamestringadmite null
  El transportista o la marca a la que pertenece el servicio.
  serviceTypestringadmite null
  ground, air o sea.
- totalChargePricenumber
  El precio cotizado. Incluye insuranceFee esté o no asegurado el envío, y improvedFoamProtectionFee. Resta insuranceFee cuando el envío no está asegurado.
- insuranceFeenumber
  El precio de asegurar el envío con este servicio. Ya está dentro de totalChargePrice; solo se cobra cuando el envío está asegurado.
- improvedFoamProtectionFeenumber
  El precio de la protección mejorada con espuma, ya incluido en totalChargePrice. Es 0 a menos que el envío la pida.
- shipmentChargeTotalPricenumber
  El precio del servicio de envío por sí solo; los descuentos de cupones se calculan sobre él. No es lo que cuesta la etiqueta: consulta totalChargePrice.
- pickupFeenumber
  Se suma al precio de la etiqueta cuando se recogen los paquetes.
- minimumPickupFeenumber
  Se suma al precio de la etiqueta cuando se recogen los paquetes.
labelobjectadmite null
La etiqueta, una vez comprada. Se incluye cuando el envío se lee por sí solo (GET /shipments/{shipmentId}).
Atributos anidados
- trackingNumberstringadmite null
  El número de rastreo de WeShipYou (WSY…). Úsalo con GET /tracking/{trackingNumber} y para cancelar la etiqueta.
createdAtstring <date-time>obligatorio
Cuándo se creó el envío.
updatedAtstring <date-time>obligatorio
Cuándo cambió el envío por última vez.

El objeto Envío

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "appliedCouponDiscount": 0,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "customsAuthorizations": {
    "required": [],
    "mincomDocumentsCount": 0,
    "canCustomerEdit": true,
    "recipientAuthorization": "optional",
    "recipientAuthorizationDocumentsCount": 0,
    "canCustomerEditRecipientAuthorization": true
  },
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

El objeto Categoría

Una categoría de contenido de envío. Cada artículo de un paquete declara una.

Atributos

uidstringobligatorio
UID de la categoría.
namestringobligatorio
Nombre visible.
slugstringobligatorio
Nombre técnico estable.
weightnumberadmite null
Peso por defecto de una unidad, en gramos.
lengthnumberadmite null
Largo por defecto, en centímetros.
widthnumberadmite null
Ancho por defecto, en centímetros.
heightnumberadmite null
Alto por defecto, en centímetros.
containsDocumentsboolean | integer
Los artículos de esta categoría son documentos. 1/true o 0/false.
containsOtherDgboolean | integer
Los artículos de esta categoría son mercancías peligrosas distintas de baterías. 1/true o 0/false.
containsLiquidsboolean | integer
Los artículos de esta categoría contienen líquidos. 1/true o 0/false.
containsBatteryPi967boolean | integer
Baterías de iones de litio contenidas en un equipo (PI 967). 1/true o 0/false.
containsBatteryPi966boolean | integer
Baterías de iones de litio embaladas con un equipo (PI 966). 1/true o 0/false.
containsBatteryPi965boolean | integer
Baterías de iones de litio sueltas (PI 965). 1/true o 0/false.
parentIdintegeradmite null
Categoría padre, cuando es una subcategoría.

El objeto Categoría

{
  "uid": "u40h56jccmdi",
  "name": "Phone Accessory (no battery)",
  "slug": "accessory_no_battery",
  "weight": null,
  "length": null,
  "width": null,
  "height": null,
  "containsDocuments": 0,
  "containsOtherDg": 0,
  "containsLiquids": 0,
  "containsBatteryPi967": 0,
  "containsBatteryPi966": 0,
  "containsBatteryPi965": 0,
  "parentId": null
}

El objeto Categoría por país

Atributos

uidstringadmite null
namestringadmite null
slugstringadmite null
weightnumberadmite null
lengthnumberadmite null
widthnumberadmite null
heightnumberadmite null
containsDocumentsbooleanadmite null
containsOtherDgbooleanadmite null
containsLiquidsbooleanadmite null
containsBatteryPi967booleanadmite null
containsBatteryPi966booleanadmite null
containsBatteryPi965booleanadmite null
customsValuenumberadmite null
qtynumberadmite null
maxWeightnumberadmite null
unitTypestringadmite null
observationsstringadmite null
isDiscontinuedbooleanadmite null
createdAtstring <date-time>admite null
updatedAtstring <date-time>admite null
parentIdnumberadmite null

El objeto Tarifa

Un servicio con el que se puede enviar el envío, y su precio en USD.

totalChargePrice siempre incluye el precio del seguro (insuranceFee), aunque el envío no esté asegurado. Los envíos no se aseguran a menos que lo pidas (insurance: true), así que en la mayoría de los casos resta insuranceFee para obtener lo que cuesta la etiqueta:

precio de la etiqueta = totalChargePrice − insuranceFee cuando el envío no está asegurado, o totalChargePrice cuando lo está;
más pickupFee y minimumPickupFee cuando se recogen los paquetes (handoverOption: "pickup" en POST /shipments/labels).

Un cupón reduce ese precio aún más.

Atributos

uidstring
El id de la tarifa. Envíalo como rateId a POST /shipments/labels.
serviceobject
El servicio de envío.
Atributos anidados
- uidstringadmite null
  El uid del servicio.
- namestringadmite null
  El nombre del servicio.
- umbrellaNamestringadmite null
  El transportista o la marca a la que pertenece el servicio.
- serviceTypestringadmite null
  ground, air o sea.
totalChargePricenumber
El precio cotizado. Incluye insuranceFee esté o no asegurado el envío, y improvedFoamProtectionFee. Resta insuranceFee cuando el envío no está asegurado.
insuranceFeenumber
El precio de asegurar el envío con este servicio. Ya está dentro de totalChargePrice; solo se cobra cuando el envío está asegurado.
improvedFoamProtectionFeenumber
El precio de la protección mejorada con espuma, ya incluido en totalChargePrice. Es 0 a menos que el envío la pida.
shipmentChargeTotalPricenumber
El precio del servicio de envío por sí solo; los descuentos de cupones se calculan sobre él. No es lo que cuesta la etiqueta: consulta totalChargePrice.
pickupFeenumber
Se suma al precio de la etiqueta cuando se recogen los paquetes.
minimumPickupFeenumber
Se suma al precio de la etiqueta cuando se recogen los paquetes.

El objeto Tarifa

{
  "uid": "k3m9x2p7q1zt",
  "service": {
    "uid": "q8c2kd0x1m4z",
    "name": "USPS Priority Mail",
    "umbrellaName": "USPS",
    "serviceType": "ground"
  },
  "totalChargePrice": 20.75,
  "insuranceFee": 2.35,
  "improvedFoamProtectionFee": 0,
  "shipmentChargeTotalPrice": 18.4,
  "pickupFee": 0,
  "minimumPickupFee": 0
}

Calcular tarifas de envío

POST/shipments/rates

Requiere un token de acceso

Cotiza todos los servicios disponibles para un envío. Envía el envío tal como lo crearías; accountId es opcional. Para cotizar paquetes que ya están en tu casillero, envía el uid de cada artículo de GET /forwarder como forwardingOrderItemId en un artículo del paquete (el ejemplo Desde artículos del casillero).

El totalChargePrice de cada tarifa incluye el seguro (insuranceFee), aunque no lo pidas. Si el envío no va a estar asegurado (lo predeterminado), resta insuranceFee para obtener el precio de su etiqueta.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

El envío que se va a crear.

accountIdstringobligatorio
- string
  El uid de tu cuenta, tal como lo devuelve POST /authentication.
- string
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
totalValuenumberobligatorio
<= 2999
insuranceboolean
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstringobligatorio
Valores permitidos:DDUDDP
weightUnitstring
Unidad de weight para cada paquete que no indique su propio weightUnit. Sin unidad en el paquete ni aquí, los pesos se leen en gramos.
Valores permitidos:gmkgozlb
dimUnitstring
Unidad de length, width y height para cada paquete que no indique su propio dimUnit. Sin unidad en el paquete ni aquí, las medidas se leen en centímetros.
Valores permitidos:cmin
senderobjectobligatorio
Atributos anidados
- addressobjectobligatorio
  Atributos anidados
  cityobject
  Atributos anidados
  namestring
  stateobject
  Atributos anidados
  namestring
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
- countryobjectobligatorio
  Un país, por su código ISO 3166-1 alfa-2.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
recipientobjectobligatorio
Atributos anidados
- addressobjectobligatorio
  Atributos anidados
  cityobject
  Atributos anidados
  namestring
  stateobject
  Atributos anidados
  namestring
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
- countryobjectobligatorio
  Un país, por su código ISO 3166-1 alfa-2.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
parcelslista de objectobligatorio
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

201

Las tarifas disponibles. Cada totalChargePrice incluye el seguro (insuranceFee); consulta el objeto Tarifa.

El objeto Tarifa

400

Paquetes no válidos, o un forwardingOrderItemId desconocido

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

POST/shipments/rates

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/rates' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "totalValue": 2999,
  "insurance": true,
  "incoterms": "DDU",
  "sender": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Ejemplos de solicitud

{
  "accountId": "CU1234567",
  "totalValue": 2999,
  "insurance": true,
  "incoterms": "DDU",
  "sender": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}

Respuesta

[
  {
    "uid": "k3m9x2p7q1zt",
    "service": {
      "uid": "q8c2kd0x1m4z",
      "name": "USPS Priority Mail",
      "umbrellaName": "USPS",
      "serviceType": "ground"
    },
    "totalChargePrice": 20.75,
    "insuranceFee": 2.35,
    "improvedFoamProtectionFee": 0,
    "shipmentChargeTotalPrice": 18.4,
    "pickupFee": 0,
    "minimumPickupFee": 0
  }
]

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Buscar envíos

GET/shipments

Requiere un token de acceso

Lista los envíos de tus cuentas.

Parámetros de consulta

accountIdstring
Limita los resultados a una de tus cuentas o a una de sus subcuentas: su uid, su número de cuenta (CU…) o su número de cuenta externo. Sin él, se incluyen las cuentas a las que perteneces y todas sus subcuentas.
$limitnumber
Número máximo de resultados (20 por defecto).
Por defecto: 20
>= 0 · <= 500
$skipnumber
Número de resultados que se omiten, para paginar.
Por defecto: 0
>= 0

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de tus envíos.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Envíoobligatorio
El objeto Envío

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

GET/shipments

curl 'https://sandbox.weshipyou.com/api/v1/shipments' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 1,
  "limit": 20,
  "skip": 0,
  "data": [
    {
      "uid": "wwbvygom0rlz",
      "state": "created",
      "statusTracking": "in transit",
      "transactionState": null,
      "externalReferenceCode": "shp1x6",
      "externalCustomerId": null,
      "externalUniqueId": null,
      "incoterms": "DDU",
      "weightUnit": "gm",
      "dimUnit": "cm",
      "weight": 1000,
      "length": 10,
      "width": 10,
      "height": 10,
      "totalValue": 10,
      "insurance": 0,
      "insuranceAmount": null,
      "appliedCouponDiscount": 0,
      "sellerNotes": null,
      "buyerNotes": null,
      "labelCreatedAt": null,
      "deliveredAt": null,
      "cancellationReason": null,
      "cancellationReasonCode": null,
      "customsAuthorizations": {
        "required": [],
        "mincomDocumentsCount": 0,
        "canCustomerEdit": true,
        "recipientAuthorization": "optional",
        "recipientAuthorizationDocumentsCount": 0,
        "canCustomerEditRecipientAuthorization": true
      },
      "createdAt": "2026-11-01T00:37:50.000Z",
      "updatedAt": "2026-11-01T00:37:50.000Z"
    }
  ]
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Agregar un envío nuevo a tu cuenta

POST/shipments

Requiere un token de acceso

Crea un envío (todavía sin etiqueta). accountId acepta el uid de la cuenta, su número de cuenta (CU…) o su número de cuenta externo. Cotízalo con POST /shipments/rates y compra la etiqueta con POST /shipments/labels.

Para enviar paquetes que ya están en tu casillero, lístalos con GET /forwarder y envía el uid de cada artículo como forwardingOrderItemId en un artículo del paquete (el ejemplo Desde artículos del casillero).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

El envío que se va a crear.

accountIdstring | integerobligatorio
- string | integer
  El uid de tu cuenta, tal como lo devuelve POST /authentication, o el uid de una de sus subcuentas (GET /accounts) para enviar en nombre de esa subcuenta.
- string | integer
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
senderobjectobligatorio
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
recipientobjectobligatorio
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
totalValuenumberobligatorio
<= 2999
externalReferenceCodestring
externalCustomerIdstringadmite null
insuranceboolean | integer
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstringobligatorio
Valores permitidos:DDUDDP
weightUnitstring
Unidad de weight para cada paquete que no indique su propio weightUnit. Se guarda en el envío, y el panel muestra el peso del envío en esa unidad. Por defecto, la weightUnit del primer paquete.
Valores permitidos:gmkgozlb
dimUnitstring
Unidad de length, width y height para cada paquete que no indique su propio dimUnit. Se guarda en el envío. Por defecto, el dimUnit del primer paquete.
Valores permitidos:cmin
parcelslista de objectobligatorio
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

201

El envío creado

El objeto Envío

400

Error de validación; data contiene el mensaje de cada campo no válido

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

POST/shipments

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Ejemplos de solicitud

{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}

Respuesta

{
  "uid": "42ailx0umn2q",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 2.5,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 450,
  "insurance": true,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "sender": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "recipient": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "createdAt": "2026-11-01T00:37:51.000Z",
  "updatedAt": "2026-11-01T00:37:51.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener un envío

GET/shipments/{shipmentId}

Requiere un token de acceso

Devuelve uno de tus envíos.

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

El envío

El objeto Envío

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

GET/shipments/{shipmentId}

curl 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "appliedCouponDiscount": 0,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "customsAuthorizations": {
    "required": [],
    "mincomDocumentsCount": 0,
    "canCustomerEdit": true,
    "recipientAuthorization": "optional",
    "recipientAuthorizationDocumentsCount": 0,
    "canCustomerEditRecipientAuthorization": true
  },
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Actualizar un envío

PATCH/shipments/{shipmentId}

Requiere un token de acceso

Cambia los campos que envías y mantiene el resto como está. Para cambiar una dirección, envía el objeto sender o recipient completo (o { "id": <address id>, "useExistingAddress": true } para usar una de tu libreta de direcciones); para cambiar el contenido, envía el arreglo parcels completo. Las tarifas se recalculan después del cambio. Un envío entregado no se puede editar.

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

Cualquiera de los campos del envío.

accountIdstring
- string
  El uid de tu cuenta, tal como lo devuelve POST /authentication.
- string
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
senderobject
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
recipientobject
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
totalValuenumber
<= 2999
externalReferenceCodestring
externalCustomerIdstring
insuranceboolean
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstring
Valores permitidos:DDUDDP
parcelslista de object
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

200

El envío actualizado

El objeto Envío

400

Error de validación, o el envío ya no se puede editar

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

PATCH/shipments/{shipmentId}

curl -X PATCH 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Respuesta

{
  "uid": "42ailx0umn2q",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "ORDER-1002",
  "externalCustomerId": "CUST-42",
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 2.5,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 450,
  "insurance": true,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "sender": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "recipient": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "createdAt": "2026-11-01T00:37:51.000Z",
  "updatedAt": "2026-11-01T00:37:52.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Eliminar un envío

DELETE/shipments/{shipmentId}

Requiere un token de acceso

Elimina un envío que todavía no tiene etiqueta (estado created). Para cancelar un envío cuya etiqueta ya se compró, usa DELETE /shipments/labels/{trackingNumber}.

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

El envío eliminado

El objeto Envío

400

El envío no se puede eliminar en su estado actual

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

DELETE/shipments/{shipmentId}

curl -X DELETE 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener categorías de envío

GET/shipments/categories

Requiere un token de acceso

Lista las categorías de contenido que puede declarar un artículo de un paquete.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de categorías de contenido de envío.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Categoríaobligatorio
El objeto Categoría

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

Prohibido

GET/shipments/categories

curl 'https://sandbox.weshipyou.com/api/v1/shipments/categories' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 30,
  "limit": 500,
  "skip": 0,
  "data": [
    {
      "uid": "u40h56jccmdi",
      "name": "Phone Accessory (no battery)",
      "slug": "accessory_no_battery",
      "weight": null,
      "length": null,
      "width": null,
      "height": null,
      "containsDocuments": 0,
      "containsOtherDg": 0,
      "containsLiquids": 0,
      "containsBatteryPi967": 0,
      "containsBatteryPi966": 0,
      "containsBatteryPi965": 0,
      "parentId": null
    }
  ]
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener categorías por país

GET/shipments/country-categories

Requiere un token de acceso

Lista las categorías de contenido que usa un país de destino para la aduana.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de categorías de contenido por país.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Categoría por paísobligatorio
El objeto Categoría por país

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

Prohibido

GET/shipments/country-categories

curl 'https://sandbox.weshipyou.com/api/v1/shipments/country-categories' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 0,
  "limit": 500,
  "skip": 0,
  "data": []
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Comprar etiquetas

POST/shipments/labels

Requiere un token de acceso

Compra la etiqueta de uno o varios envíos con la tarifa que elegiste. El cobro se registra en tu billetera de WeShipYou: primero se usa tu saldo y solo el resto se cobra a paymentMethod.

Cada etiqueta cuesta el totalChargePrice de su tarifa menos insuranceFee cuando el envío no está asegurado (las tarifas siempre incluyen el seguro), más pickupFee y minimumPickupFee para una entrega pickup. Un cupón reduce ese precio aún más.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

accountIdstring
uid de la cuenta, número de cuenta (CU…) o número de cuenta externo.
paymentMethod"credit_line" | object
Cómo pagar lo que el saldo de tu billetera no cubre: "credit_line" para cuentas con línea de crédito, o una tarjeta guardada como { "paymentMethodId": "pm_…" }. Se puede omitir cuando el saldo cubre el monto completo.
Atributos anidados
Uno de
Valores permitidos:credit_line
paymentMethodIdstring
usePointsboolean
Usa primero tus puntos de WeShipYou.
insuranceboolean
Asegura todos los envíos de esta compra (true) o ninguno (false). Omítelo para mantener el insurance propio de cada envío.
handoverOptionslista de objectobligatorio
Atributos anidados
- handoverOptionstringobligatorio
  Valores permitidos:dropoffpickup
- pickupDatestring <date>
- pickupTimestring
- shipmentslista de objectobligatorio
  Atributos anidados
  shipmentIdstringobligatorio
  uid del envío o número de rastreo de WeShipYou.
  rateIdstringobligatorio
  El uid de la tarifa elegida para ese envío.

Respuestas

201

El resultado de cada lote de etiquetas

statusstringobligatorio
Resultado del lote.
Valores permitidos:fulfilledrejected
reasonany
Por qué falló el lote, cuando status es rejected.

400

Solicitud no válida, pago no encontrado o fondos insuficientes

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

POST/shipments/labels

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/labels' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "paymentMethod": "credit_line",
  "usePoints": true,
  "insurance": false,
  "handoverOptions": [
    {
      "handoverOption": "dropoff",
      "pickupDate": "2026-10-02",
      "pickupTime": "10:00",
      "shipments": [
        {
          "shipmentId": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d",
          "rateId": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e"
        }
      ]
    }
  ]
}'

Respuesta

[
  {
    "status": "fulfilled"
  }
]

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Cancelar una etiqueta

DELETE/shipments/labels/{trackingNumber}

Requiere un token de acceso

Cancela una etiqueta que el transportista todavía no ha recogido. Lo que pagaste por ella se acredita de vuelta a tu billetera de WeShipYou.

Parámetros de ruta

trackingNumberstringobligatorio
El número de rastreo de WeShipYou de la etiqueta.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

La etiqueta se canceló

idstringobligatorio
Número de rastreo de WeShipYou de la etiqueta cancelada.

400

La etiqueta ya no se puede cancelar

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

404

No encontrado

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

409

El envío cambió de estado durante la cancelación; vuelve a intentarlo

namestring
Siempre Conflict
messagestring
codenumber
Siempre 409
classNamestring
Siempre conflict
dataobject

DELETE/shipments/labels/{trackingNumber}

curl -X DELETE 'https://sandbox.weshipyou.com/api/v1/shipments/labels/{trackingNumber}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "id": "WSYOP5B60J3SCU"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Confirmar una entrega

POST/shipments/confirm-delivery

No necesita token de acceso

Registra que el destinatario recibió un envío que está en tránsito o entregado. No se necesita token de acceso: el número de rastreo y el número de cuenta identifican el envío.

Un envío que ya está delivered siempre se puede confirmar. Un envío in_transit solo se puede confirmar cuando está atrasado (su etiqueta se compró hace al menos 30 días y, si tiene una fecha prometida de entrega, pasaron al menos 15 días desde esa fecha) y no ha llegado a WeShipYou en destino. Cuando el paquete ya está con WeShipYou en Cuba (recogido en el aeropuerto o el puerto, en un viaje de tránsito o en una ruta de entrega), solo WeShipYou lo marca como entregado. Un rechazo es un 400 con data.code: delivery-confirmation-at-destination, o delivery-confirmation-too-early con data.availableFrom.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

trackingNumberstringobligatorio
accountNumberstringobligatorio
El número de cuenta del dueño del envío (CU…).

Respuestas

201

Entrega registrada

okboolean
Siempre true
idstring
El número de rastreo.

400

Faltan campos, la cuenta o el envío no existen, o el envío no está en tránsito

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

POST/shipments/confirm-delivery

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/confirm-delivery' \
  -H "Content-Type: application/json" \
  -d '{
  "trackingNumber": "WSY0000000000US",
  "accountNumber": "CU1234567"
}'

Respuesta

{
  "ok": true,
  "id": "WSYZD8KI41VSCU"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Envíos

Crea, cotiza, etiqueta, cancela y confirma tus envíos

POST/shipments/rates
GET/shipments
POST/shipments
GET/shipments/{shipmentId}
PATCH/shipments/{shipmentId}
DELETE/shipments/{shipmentId}
GET/shipments/categories
GET/shipments/country-categories
POST/shipments/labels
DELETE/shipments/labels/{trackingNumber}
POST/shipments/confirm-delivery

El objeto Envío

Un envío: qué se envía, de quién, para quién, y el estado de su etiqueta y su entrega.

Atributos

uidstringobligatorio
UID del envío. Úsalo como shipmentId.
statestringobligatorio
Estado del ciclo de vida, desde created pasando por label_created hasta delivered o cancelled.
statusTrackingstringadmite null
Último estado de rastreo del transportista, en palabras.
transactionStatestringadmite null
Estado de cobro del envío, cuando se cobró o se reembolsó.
externalReferenceCodestringadmite null
Tu propia referencia para el envío.
externalCustomerIdstringadmite null
Tu propia referencia de cliente.
externalUniqueIdstringadmite null
Tu propia referencia de idempotencia.
incotermsstringobligatorio
Quién paga los aranceles: el destinatario (DDU) o el remitente (DDP).
Valores permitidos:DDUDDP
weightUnitstringobligatorio
Unidad de weight.
Valores permitidos:gmkgozlb
dimUnitstringobligatorio
Unidad de length, width y height.
weightnumberadmite null
Peso total.
lengthnumberadmite null
Largo de la caja.
widthnumberadmite null
Ancho de la caja.
heightnumberadmite null
Alto de la caja.
totalValuenumberadmite null
Valor declarado del contenido, USD.
insuranceboolean | integer
El envío está asegurado. 1/true o 0/false.
insuranceAmountnumberadmite null
Monto asegurado, USD.
appliedCouponDiscountnumberadmite null
Descuento de cupón aplicado al precio de la etiqueta, USD.
sellerNotesstringadmite null
Notas del remitente.
buyerNotesstringadmite null
Notas del destinatario.
labelCreatedAtstring <date-time>admite null
Cuándo se compró la etiqueta.
deliveredAtstring <date-time>admite null
Cuándo el transportista entregó el envío.
cancellationReasonstringadmite null
Por qué se canceló el envío.
cancellationReasonCodestringadmite null
Código técnico del motivo de cancelación.
customsAuthorizationsobject
Documentos de aduana que exige el destino, y si el cliente todavía puede editarlos.
senderobjectadmite null
El remitente. Se incluye cuando el envío se lee solo.
Atributos anidados
- uidstring
  UID de la entrada de la libreta de direcciones.
- nicknamestringadmite null
  Tu etiqueta para la entrada.
- companyNamestringadmite null
  Nombre de la empresa.
- namestringadmite null
  Nombre completo.
- taxIdstringadmite null
  Id fiscal.
- emailstringadmite null
  Correo electrónico.
- phonestringadmite null
  Número de teléfono.
- isResidentialboolean | integer
  Dirección de entrega residencial.
- statusstring
  Estado de la entrada.
- addressobjectadmite null
  Una dirección postal tal como WeShipYou la interpretó.
  Atributos anidados
  uidstring
  UID de la dirección.
  houseNumberstringadmite null
  Número de casa o edificio.
  roadstringadmite null
  Nombre de la calle.
  unitstringadmite null
  Apartamento, oficina o unidad.
  cityobjectadmite null
  Atributos anidados
  namestring
  Nombre de la ciudad.
  stateobjectadmite null
  Atributos anidados
  namestring
  isoCodestringadmite null
  Código del estado.
  countryobjectadmite null
  Atributos anidados
  isoCodestring
  namestring
  postal_codeobjectadmite null
  Atributos anidados
  postalCodestring
recipientobjectadmite null
El destinatario. Se incluye cuando el envío se lee solo.
Atributos anidados
- uidstring
  UID de la entrada de la libreta de direcciones.
- nicknamestringadmite null
  Tu etiqueta para la entrada.
- companyNamestringadmite null
  Nombre de la empresa.
- namestringadmite null
  Nombre completo.
- taxIdstringadmite null
  Id fiscal.
- emailstringadmite null
  Correo electrónico.
- phonestringadmite null
  Número de teléfono.
- isResidentialboolean | integer
  Dirección de entrega residencial.
- statusstring
  Estado de la entrada.
- addressobjectadmite null
  Una dirección postal tal como WeShipYou la interpretó.
  Atributos anidados
  uidstring
  UID de la dirección.
  houseNumberstringadmite null
  Número de casa o edificio.
  roadstringadmite null
  Nombre de la calle.
  unitstringadmite null
  Apartamento, oficina o unidad.
  cityobjectadmite null
  Atributos anidados
  namestring
  Nombre de la ciudad.
  stateobjectadmite null
  Atributos anidados
  namestring
  isoCodestringadmite null
  Código del estado.
  countryobjectadmite null
  Atributos anidados
  isoCodestring
  namestring
  postal_codeobjectadmite null
  Atributos anidados
  postalCodestring
parcelslista de object
Los paquetes y sus artículos. Se incluyen cuando el envío se lee solo.
parcel_rateslista de Tarifa
Los servicios con los que se puede enviar este envío y sus precios. Se incluye en la respuesta de POST /shipments y PATCH /shipments/{shipmentId}; elige uno y cómpralo con POST /shipments/labels. Su totalChargePrice incluye el seguro (insuranceFee) aunque el envío no esté asegurado; consulta el objeto Tarifa.
Atributos anidados
- uidstringobligatorio
  El id de la tarifa. Envíalo como rateId a POST /shipments/labels.
- serviceobject
  El servicio de envío.
  Atributos anidados
  uidstringadmite null
  El uid del servicio.
  namestringadmite null
  El nombre del servicio.
  umbrellaNamestringadmite null
  El transportista o la marca a la que pertenece el servicio.
  serviceTypestringadmite null
  ground, air o sea.
- totalChargePricenumber
  El precio cotizado. Incluye insuranceFee esté o no asegurado el envío, y improvedFoamProtectionFee. Resta insuranceFee cuando el envío no está asegurado.
- insuranceFeenumber
  El precio de asegurar el envío con este servicio. Ya está dentro de totalChargePrice; solo se cobra cuando el envío está asegurado.
- improvedFoamProtectionFeenumber
  El precio de la protección mejorada con espuma, ya incluido en totalChargePrice. Es 0 a menos que el envío la pida.
- shipmentChargeTotalPricenumber
  El precio del servicio de envío por sí solo; los descuentos de cupones se calculan sobre él. No es lo que cuesta la etiqueta: consulta totalChargePrice.
- pickupFeenumber
  Se suma al precio de la etiqueta cuando se recogen los paquetes.
- minimumPickupFeenumber
  Se suma al precio de la etiqueta cuando se recogen los paquetes.
labelobjectadmite null
La etiqueta, una vez comprada. Se incluye cuando el envío se lee por sí solo (GET /shipments/{shipmentId}).
Atributos anidados
- trackingNumberstringadmite null
  El número de rastreo de WeShipYou (WSY…). Úsalo con GET /tracking/{trackingNumber} y para cancelar la etiqueta.
createdAtstring <date-time>obligatorio
Cuándo se creó el envío.
updatedAtstring <date-time>obligatorio
Cuándo cambió el envío por última vez.

El objeto Envío

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "appliedCouponDiscount": 0,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "customsAuthorizations": {
    "required": [],
    "mincomDocumentsCount": 0,
    "canCustomerEdit": true,
    "recipientAuthorization": "optional",
    "recipientAuthorizationDocumentsCount": 0,
    "canCustomerEditRecipientAuthorization": true
  },
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

El objeto Categoría

Una categoría de contenido de envío. Cada artículo de un paquete declara una.

Atributos

uidstringobligatorio
UID de la categoría.
namestringobligatorio
Nombre visible.
slugstringobligatorio
Nombre técnico estable.
weightnumberadmite null
Peso por defecto de una unidad, en gramos.
lengthnumberadmite null
Largo por defecto, en centímetros.
widthnumberadmite null
Ancho por defecto, en centímetros.
heightnumberadmite null
Alto por defecto, en centímetros.
containsDocumentsboolean | integer
Los artículos de esta categoría son documentos. 1/true o 0/false.
containsOtherDgboolean | integer
Los artículos de esta categoría son mercancías peligrosas distintas de baterías. 1/true o 0/false.
containsLiquidsboolean | integer
Los artículos de esta categoría contienen líquidos. 1/true o 0/false.
containsBatteryPi967boolean | integer
Baterías de iones de litio contenidas en un equipo (PI 967). 1/true o 0/false.
containsBatteryPi966boolean | integer
Baterías de iones de litio embaladas con un equipo (PI 966). 1/true o 0/false.
containsBatteryPi965boolean | integer
Baterías de iones de litio sueltas (PI 965). 1/true o 0/false.
parentIdintegeradmite null
Categoría padre, cuando es una subcategoría.

El objeto Categoría

{
  "uid": "u40h56jccmdi",
  "name": "Phone Accessory (no battery)",
  "slug": "accessory_no_battery",
  "weight": null,
  "length": null,
  "width": null,
  "height": null,
  "containsDocuments": 0,
  "containsOtherDg": 0,
  "containsLiquids": 0,
  "containsBatteryPi967": 0,
  "containsBatteryPi966": 0,
  "containsBatteryPi965": 0,
  "parentId": null
}

El objeto Categoría por país

Atributos

uidstringadmite null
namestringadmite null
slugstringadmite null
weightnumberadmite null
lengthnumberadmite null
widthnumberadmite null
heightnumberadmite null
containsDocumentsbooleanadmite null
containsOtherDgbooleanadmite null
containsLiquidsbooleanadmite null
containsBatteryPi967booleanadmite null
containsBatteryPi966booleanadmite null
containsBatteryPi965booleanadmite null
customsValuenumberadmite null
qtynumberadmite null
maxWeightnumberadmite null
unitTypestringadmite null
observationsstringadmite null
isDiscontinuedbooleanadmite null
createdAtstring <date-time>admite null
updatedAtstring <date-time>admite null
parentIdnumberadmite null

El objeto Tarifa

Un servicio con el que se puede enviar el envío, y su precio en USD.

precio de la etiqueta = totalChargePrice − insuranceFee cuando el envío no está asegurado, o totalChargePrice cuando lo está;
más pickupFee y minimumPickupFee cuando se recogen los paquetes (handoverOption: "pickup" en POST /shipments/labels).

Un cupón reduce ese precio aún más.

Atributos

uidstring
El id de la tarifa. Envíalo como rateId a POST /shipments/labels.
serviceobject
El servicio de envío.
Atributos anidados
- uidstringadmite null
  El uid del servicio.
- namestringadmite null
  El nombre del servicio.
- umbrellaNamestringadmite null
  El transportista o la marca a la que pertenece el servicio.
- serviceTypestringadmite null
  ground, air o sea.
totalChargePricenumber
El precio cotizado. Incluye insuranceFee esté o no asegurado el envío, y improvedFoamProtectionFee. Resta insuranceFee cuando el envío no está asegurado.
insuranceFeenumber
El precio de asegurar el envío con este servicio. Ya está dentro de totalChargePrice; solo se cobra cuando el envío está asegurado.
improvedFoamProtectionFeenumber
El precio de la protección mejorada con espuma, ya incluido en totalChargePrice. Es 0 a menos que el envío la pida.
shipmentChargeTotalPricenumber
El precio del servicio de envío por sí solo; los descuentos de cupones se calculan sobre él. No es lo que cuesta la etiqueta: consulta totalChargePrice.
pickupFeenumber
Se suma al precio de la etiqueta cuando se recogen los paquetes.
minimumPickupFeenumber
Se suma al precio de la etiqueta cuando se recogen los paquetes.

El objeto Tarifa

{
  "uid": "k3m9x2p7q1zt",
  "service": {
    "uid": "q8c2kd0x1m4z",
    "name": "USPS Priority Mail",
    "umbrellaName": "USPS",
    "serviceType": "ground"
  },
  "totalChargePrice": 20.75,
  "insuranceFee": 2.35,
  "improvedFoamProtectionFee": 0,
  "shipmentChargeTotalPrice": 18.4,
  "pickupFee": 0,
  "minimumPickupFee": 0
}

Calcular tarifas de envío

POST/shipments/rates

Requiere un token de acceso

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

El envío que se va a crear.

accountIdstringobligatorio
- string
  El uid de tu cuenta, tal como lo devuelve POST /authentication.
- string
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
totalValuenumberobligatorio
<= 2999
insuranceboolean
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstringobligatorio
Valores permitidos:DDUDDP
weightUnitstring
Unidad de weight para cada paquete que no indique su propio weightUnit. Sin unidad en el paquete ni aquí, los pesos se leen en gramos.
Valores permitidos:gmkgozlb
dimUnitstring
Unidad de length, width y height para cada paquete que no indique su propio dimUnit. Sin unidad en el paquete ni aquí, las medidas se leen en centímetros.
Valores permitidos:cmin
senderobjectobligatorio
Atributos anidados
- addressobjectobligatorio
  Atributos anidados
  cityobject
  Atributos anidados
  namestring
  stateobject
  Atributos anidados
  namestring
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
- countryobjectobligatorio
  Un país, por su código ISO 3166-1 alfa-2.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
recipientobjectobligatorio
Atributos anidados
- addressobjectobligatorio
  Atributos anidados
  cityobject
  Atributos anidados
  namestring
  stateobject
  Atributos anidados
  namestring
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
- countryobjectobligatorio
  Un país, por su código ISO 3166-1 alfa-2.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
parcelslista de objectobligatorio
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

201

Las tarifas disponibles. Cada totalChargePrice incluye el seguro (insuranceFee); consulta el objeto Tarifa.

El objeto Tarifa

400

Paquetes no válidos, o un forwardingOrderItemId desconocido

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

POST/shipments/rates

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/rates' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "totalValue": 2999,
  "insurance": true,
  "incoterms": "DDU",
  "sender": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Ejemplos de solicitud

{
  "accountId": "CU1234567",
  "totalValue": 2999,
  "insurance": true,
  "incoterms": "DDU",
  "sender": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "country": {
      "isoCode": "US"
    }
  },
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}

Respuesta

[
  {
    "uid": "k3m9x2p7q1zt",
    "service": {
      "uid": "q8c2kd0x1m4z",
      "name": "USPS Priority Mail",
      "umbrellaName": "USPS",
      "serviceType": "ground"
    },
    "totalChargePrice": 20.75,
    "insuranceFee": 2.35,
    "improvedFoamProtectionFee": 0,
    "shipmentChargeTotalPrice": 18.4,
    "pickupFee": 0,
    "minimumPickupFee": 0
  }
]

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Buscar envíos

GET/shipments

Requiere un token de acceso

Lista los envíos de tus cuentas.

Parámetros de consulta

accountIdstring
Limita los resultados a una de tus cuentas o a una de sus subcuentas: su uid, su número de cuenta (CU…) o su número de cuenta externo. Sin él, se incluyen las cuentas a las que perteneces y todas sus subcuentas.
$limitnumber
Número máximo de resultados (20 por defecto).
Por defecto: 20
>= 0 · <= 500
$skipnumber
Número de resultados que se omiten, para paginar.
Por defecto: 0
>= 0

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de tus envíos.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Envíoobligatorio
El objeto Envío

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

GET/shipments

curl 'https://sandbox.weshipyou.com/api/v1/shipments' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 1,
  "limit": 20,
  "skip": 0,
  "data": [
    {
      "uid": "wwbvygom0rlz",
      "state": "created",
      "statusTracking": "in transit",
      "transactionState": null,
      "externalReferenceCode": "shp1x6",
      "externalCustomerId": null,
      "externalUniqueId": null,
      "incoterms": "DDU",
      "weightUnit": "gm",
      "dimUnit": "cm",
      "weight": 1000,
      "length": 10,
      "width": 10,
      "height": 10,
      "totalValue": 10,
      "insurance": 0,
      "insuranceAmount": null,
      "appliedCouponDiscount": 0,
      "sellerNotes": null,
      "buyerNotes": null,
      "labelCreatedAt": null,
      "deliveredAt": null,
      "cancellationReason": null,
      "cancellationReasonCode": null,
      "customsAuthorizations": {
        "required": [],
        "mincomDocumentsCount": 0,
        "canCustomerEdit": true,
        "recipientAuthorization": "optional",
        "recipientAuthorizationDocumentsCount": 0,
        "canCustomerEditRecipientAuthorization": true
      },
      "createdAt": "2026-11-01T00:37:50.000Z",
      "updatedAt": "2026-11-01T00:37:50.000Z"
    }
  ]
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Agregar un envío nuevo a tu cuenta

POST/shipments

Requiere un token de acceso

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

El envío que se va a crear.

accountIdstring | integerobligatorio
- string | integer
  El uid de tu cuenta, tal como lo devuelve POST /authentication, o el uid de una de sus subcuentas (GET /accounts) para enviar en nombre de esa subcuenta.
- string | integer
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
senderobjectobligatorio
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
recipientobjectobligatorio
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
totalValuenumberobligatorio
<= 2999
externalReferenceCodestring
externalCustomerIdstringadmite null
insuranceboolean | integer
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstringobligatorio
Valores permitidos:DDUDDP
weightUnitstring
Unidad de weight para cada paquete que no indique su propio weightUnit. Se guarda en el envío, y el panel muestra el peso del envío en esa unidad. Por defecto, la weightUnit del primer paquete.
Valores permitidos:gmkgozlb
dimUnitstring
Unidad de length, width y height para cada paquete que no indique su propio dimUnit. Se guarda en el envío. Por defecto, el dimUnit del primer paquete.
Valores permitidos:cmin
parcelslista de objectobligatorio
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

201

El envío creado

El objeto Envío

400

Error de validación; data contiene el mensaje de cada campo no válido

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

POST/shipments

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Ejemplos de solicitud

{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}

Respuesta

{
  "uid": "42ailx0umn2q",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 2.5,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 450,
  "insurance": true,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "sender": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "recipient": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "createdAt": "2026-11-01T00:37:51.000Z",
  "updatedAt": "2026-11-01T00:37:51.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener un envío

GET/shipments/{shipmentId}

Requiere un token de acceso

Devuelve uno de tus envíos.

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

El envío

El objeto Envío

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

GET/shipments/{shipmentId}

curl 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "appliedCouponDiscount": 0,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "customsAuthorizations": {
    "required": [],
    "mincomDocumentsCount": 0,
    "canCustomerEdit": true,
    "recipientAuthorization": "optional",
    "recipientAuthorizationDocumentsCount": 0,
    "canCustomerEditRecipientAuthorization": true
  },
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Actualizar un envío

PATCH/shipments/{shipmentId}

Requiere un token de acceso

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

Cualquiera de los campos del envío.

accountIdstring
- string
  El uid de tu cuenta, tal como lo devuelve POST /authentication.
- string
  Tu número de cuenta (CU…).
  como máximo 10 caracteres
senderobject
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
recipientobject
Atributos anidados
- useExistingAddressbooleanobligatorio
Uno de
useExistingAddressboolean
Siempre false
nicknamestringadmite null
addressobjectobligatorio
Atributos anidados
cityobject
Atributos anidados
namestringadmite null
stateobject
Atributos anidados
namestringadmite null
streetstring
Dirección, incluido el número de edificio o apartamento.
postalCodestring
namestringobligatorioadmite null
al menos 1 caracteres
companyNamestringadmite null
taxIdstringadmite null
taxIdCountryobject
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
phonestring <phone>obligatorioadmite null
al menos 1 caracteres
emailstring <email>obligatorioadmite null
Correo del destinatario
countryobjectobligatorio
Un país, por su código ISO 3166-1 alfa-2.
Atributos anidados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exactamente 2 caracteres
useExistingAddressboolean
addressobjectobligatorio
Atributos anidados
idnumber <int64>
ID de la dirección
totalValuenumber
<= 2999
externalReferenceCodestring
externalCustomerIdstring
insuranceboolean
Asegura el envío. Por defecto es false. Las tarifas siempre incluyen el precio del seguro (insuranceFee) en totalChargePrice; solo se cobra cuando esto es true.
incotermsstring
Valores permitidos:DDUDDP
parcelslista de object
al menos 1 elementos · como máximo 100 elementos
Atributos anidados
- dimUnitstringobligatorio
  Unidad de length, width y height.
  Valores permitidos:cmin
- widthnumberobligatorio
- lengthnumberobligatorio
- heightnumberobligatorio
- weightUnitstringobligatorio
  Unidad de weight.
  Valores permitidos:gmkgozlb
  Por defecto: gm
- weightnumberobligatorio
  >= 0.01
- parcel_itemslista de objectobligatorio
  al menos 1 elementos · como máximo 100 elementos
  Atributos anidados
  skustring
  forwardingOrderItemIdstring
  Envía un paquete que ya está en tu casillero: el uid del artículo de la orden de reenvío, tal como lo lista GET /forwarder. El artículo debe pertenecer a la cuenta del envío. Su peso y su cantidad, y su valor declarado cuando lo tiene, se leen del casillero, y las dimensiones del paquete se recalculan a partir de su peso. Un uid desconocido, o un artículo de otra cuenta, es un 400.
  descriptionstringobligatorio
  al menos 1 caracteres
  categoryobjectobligatorio
  Atributos anidados
  slugstringobligatorio
  pricenumberobligatorio
  qtynumberobligatorio
  originCountryobject
  Atributos anidados
  isoCodestring
  al menos 2 caracteres
  weightnumber
  currencystring | Currencyobligatorio
  Moneda del valor del artículo: un código ISO 4217 o un objeto de moneda.
  Atributos anidados
  Uno de

Respuestas

200

El envío actualizado

El objeto Envío

400

Error de validación, o el envío ya no se puede editar

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

PATCH/shipments/{shipmentId}

curl -X PATCH 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "sender": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "recipient": {
    "useExistingAddress": false,
    "nickname": "Main office",
    "address": {
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida"
        }
      },
      "street": "924 NW 36 Ave",
      "postalCode": "33033"
    },
    "name": "John Doe",
    "companyName": "We Ship You Corp",
    "taxId": "88-1345985",
    "taxIdCountry": {
      "isoCode": "US"
    },
    "phone": "+1 (786) 651-0451",
    "email": "john.doe@weshipyou.com",
    "country": {
      "isoCode": "US"
    }
  },
  "totalValue": 2999,
  "externalReferenceCode": "ORDER-1001",
  "externalCustomerId": "CUST-42",
  "insurance": true,
  "incoterms": "DDU",
  "parcels": [
    {
      "dimUnit": "cm",
      "width": 10,
      "length": 10,
      "height": 10,
      "weightUnit": "gm",
      "weight": 100,
      "parcel_items": [
        {
          "sku": "SKU-WSY-EXAMPLE",
          "description": "Play Station 4",
          "category": {
            "slug": "board_games"
          },
          "price": 450,
          "qty": 1,
          "originCountry": {
            "isoCode": "JP"
          },
          "weight": 2.5,
          "currency": "USD"
        }
      ]
    }
  ]
}'

Respuesta

{
  "uid": "42ailx0umn2q",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "ORDER-1002",
  "externalCustomerId": "CUST-42",
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 2.5,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 450,
  "insurance": true,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "sender": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "recipient": {
    "uid": "vbnk8892rbji",
    "nickname": "Main office",
    "companyName": "We Ship You Corp",
    "name": "John Doe",
    "taxId": "88-1345985",
    "email": "john.doe@weshipyou.com",
    "phone": "+1 (786) 651-0451",
    "isResidential": false,
    "status": "active",
    "address": {
      "uid": "e9j57zlvd0z8",
      "houseNumber": "924",
      "road": "nw 36 ave",
      "unit": null,
      "city": {
        "name": "Homestead",
        "state": {
          "name": "Florida",
          "isoCode": "FL",
          "country": {
            "isoCode": "US",
            "name": "United States"
          }
        }
      },
      "postal_code": {
        "postalCode": "33033"
      }
    }
  },
  "createdAt": "2026-11-01T00:37:51.000Z",
  "updatedAt": "2026-11-01T00:37:52.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Eliminar un envío

DELETE/shipments/{shipmentId}

Requiere un token de acceso

Elimina un envío que todavía no tiene etiqueta (estado created). Para cancelar un envío cuya etiqueta ya se compró, usa DELETE /shipments/labels/{trackingNumber}.

Parámetros de ruta

shipmentIdstringobligatorio
El uid del envío, o su número de rastreo de WeShipYou (WSY…).

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

El envío eliminado

El objeto Envío

400

El envío no se puede eliminar en su estado actual

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

404

Ningún envío tiene ese id

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

DELETE/shipments/{shipmentId}

curl -X DELETE 'https://sandbox.weshipyou.com/api/v1/shipments/{shipmentId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "uid": "wwbvygom0rlz",
  "state": "created",
  "statusTracking": "in transit",
  "transactionState": null,
  "externalReferenceCode": "shp1x6",
  "externalCustomerId": null,
  "externalUniqueId": null,
  "incoterms": "DDU",
  "weightUnit": "gm",
  "dimUnit": "cm",
  "weight": 1000,
  "length": 10,
  "width": 10,
  "height": 10,
  "totalValue": 10,
  "insurance": 0,
  "insuranceAmount": null,
  "sellerNotes": null,
  "buyerNotes": null,
  "labelCreatedAt": null,
  "deliveredAt": null,
  "cancellationReason": null,
  "cancellationReasonCode": null,
  "createdAt": "2026-11-01T00:37:50.000Z",
  "updatedAt": "2026-11-01T00:37:50.000Z"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener categorías de envío

GET/shipments/categories

Requiere un token de acceso

Lista las categorías de contenido que puede declarar un artículo de un paquete.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de categorías de contenido de envío.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Categoríaobligatorio
El objeto Categoría

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

Prohibido

GET/shipments/categories

curl 'https://sandbox.weshipyou.com/api/v1/shipments/categories' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 30,
  "limit": 500,
  "skip": 0,
  "data": [
    {
      "uid": "u40h56jccmdi",
      "name": "Phone Accessory (no battery)",
      "slug": "accessory_no_battery",
      "weight": null,
      "length": null,
      "width": null,
      "height": null,
      "containsDocuments": 0,
      "containsOtherDg": 0,
      "containsLiquids": 0,
      "containsBatteryPi967": 0,
      "containsBatteryPi966": 0,
      "containsBatteryPi965": 0,
      "parentId": null
    }
  ]
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Obtener categorías por país

GET/shipments/country-categories

Requiere un token de acceso

Lista las categorías de contenido que usa un país de destino para la aduana.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

Una página de categorías de contenido por país.

totalintegerobligatorio
Número total de registros que coinciden.
limitintegerobligatorio
Tamaño de página usado en esta respuesta.
skipintegerobligatorio
Número de registros omitidos antes de esta página.
datalista de Categoría por paísobligatorio
El objeto Categoría por país

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

Prohibido

GET/shipments/country-categories

curl 'https://sandbox.weshipyou.com/api/v1/shipments/country-categories' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "total": 0,
  "limit": 500,
  "skip": 0,
  "data": []
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Comprar etiquetas

POST/shipments/labels

Requiere un token de acceso

Compra la etiqueta de uno o varios envíos con la tarifa que elegiste. El cobro se registra en tu billetera de WeShipYou: primero se usa tu saldo y solo el resto se cobra a paymentMethod.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

accountIdstring
uid de la cuenta, número de cuenta (CU…) o número de cuenta externo.
paymentMethod"credit_line" | object
Cómo pagar lo que el saldo de tu billetera no cubre: "credit_line" para cuentas con línea de crédito, o una tarjeta guardada como { "paymentMethodId": "pm_…" }. Se puede omitir cuando el saldo cubre el monto completo.
Atributos anidados
Uno de
Valores permitidos:credit_line
paymentMethodIdstring
usePointsboolean
Usa primero tus puntos de WeShipYou.
insuranceboolean
Asegura todos los envíos de esta compra (true) o ninguno (false). Omítelo para mantener el insurance propio de cada envío.
handoverOptionslista de objectobligatorio
Atributos anidados
- handoverOptionstringobligatorio
  Valores permitidos:dropoffpickup
- pickupDatestring <date>
- pickupTimestring
- shipmentslista de objectobligatorio
  Atributos anidados
  shipmentIdstringobligatorio
  uid del envío o número de rastreo de WeShipYou.
  rateIdstringobligatorio
  El uid de la tarifa elegida para ese envío.

Respuestas

201

El resultado de cada lote de etiquetas

statusstringobligatorio
Resultado del lote.
Valores permitidos:fulfilledrejected
reasonany
Por qué falló el lote, cuando status es rejected.

400

Solicitud no válida, pago no encontrado o fondos insuficientes

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

POST/shipments/labels

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/labels' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "CU1234567",
  "paymentMethod": "credit_line",
  "usePoints": true,
  "insurance": false,
  "handoverOptions": [
    {
      "handoverOption": "dropoff",
      "pickupDate": "2026-10-02",
      "pickupTime": "10:00",
      "shipments": [
        {
          "shipmentId": "6f1c2b8e-3d4a-4f5b-9c6d-7e8f9a0b1c2d",
          "rateId": "0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e"
        }
      ]
    }
  ]
}'

Respuesta

[
  {
    "status": "fulfilled"
  }
]

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Cancelar una etiqueta

DELETE/shipments/labels/{trackingNumber}

Requiere un token de acceso

Cancela una etiqueta que el transportista todavía no ha recogido. Lo que pagaste por ella se acredita de vuelta a tu billetera de WeShipYou.

Parámetros de ruta

trackingNumberstringobligatorio
El número de rastreo de WeShipYou de la etiqueta.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Respuestas

200

La etiqueta se canceló

idstringobligatorio
Número de rastreo de WeShipYou de la etiqueta cancelada.

400

La etiqueta ya no se puede cancelar

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

401

Token de acceso ausente o no válido

namestring
Siempre NotAuthenticated
messagestring
codenumber
Siempre 401
classNamestring
Siempre not-authenticated
dataobject

403

No tienes acceso a esta cuenta

namestring
Siempre Forbidden
messagestring
codenumber
Siempre 403
classNamestring
Siempre forbidden
dataobject

404

No encontrado

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre not-found
dataobject

409

El envío cambió de estado durante la cancelación; vuelve a intentarlo

namestring
Siempre Conflict
messagestring
codenumber
Siempre 409
classNamestring
Siempre conflict
dataobject

DELETE/shipments/labels/{trackingNumber}

curl -X DELETE 'https://sandbox.weshipyou.com/api/v1/shipments/labels/{trackingNumber}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Respuesta

{
  "id": "WSYOP5B60J3SCU"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.

Confirmar una entrega

POST/shipments/confirm-delivery

No necesita token de acceso

Registra que el destinatario recibió un envío que está en tránsito o entregado. No se necesita token de acceso: el número de rastreo y el número de cuenta identifican el envío.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

trackingNumberstringobligatorio
accountNumberstringobligatorio
El número de cuenta del dueño del envío (CU…).

Respuestas

201

Entrega registrada

okboolean
Siempre true
idstring
El número de rastreo.

400

Faltan campos, la cuenta o el envío no existen, o el envío no está en tránsito

namestring
Siempre BadRequest
messagestring
codenumber
Siempre 400
classNamestring
Siempre bad-request
dataobject

POST/shipments/confirm-delivery

curl -X POST 'https://sandbox.weshipyou.com/api/v1/shipments/confirm-delivery' \
  -H "Content-Type: application/json" \
  -d '{
  "trackingNumber": "WSY0000000000US",
  "accountNumber": "CU1234567"
}'

Respuesta

{
  "ok": true,
  "id": "WSYZD8KI41VSCU"
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.