Saltar al contenido principal
POST
/
client
/
shipments
/
create
Create a shipment
curl --request POST \
  --url https://api.ship.uniuni.com/prod/client/shipments/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": {
    "name": "Jane Doe",
    "phone": "+1-604-123-4567",
    "email": "jane@example.com",
    "signature": false
  },
  "address": {
    "address1": "3460 Cawthra Road",
    "city": "Mississauga",
    "province": "ON",
    "postalCode": "L5A 2Y1",
    "country": "CA"
  },
  "dimensions": {
    "length": 1,
    "width": 1,
    "height": 1,
    "dimensionUnit": "INCH"
  },
  "weight": {
    "value": 1,
    "weightUnit": "LB"
  },
  "postageType": "STANDARD",
  "note": "Gift Box",
  "shipmentLineItems": [
    {
      "description": "T-shirt",
      "quantity": 1,
      "unit_value": 10,
      "currency": "CAD"
    }
  ]
}
'
{ "message": "Shipment created successfully", "code": 0, "data": { "orderNumber": "UNI031455E90", "trackingId": "UR07300000000005351", "recipient": { "name": "Jane Doe", "phone": "+1-604-123-4567", "email": "jane@example.com" }, "address": { "address1": "2455 Meadowvale Blvd", "city": "Mississauga", "province": "ON", "postalCode": "L5N 0H1", "country": "CA" }, "dimensions": { "length": 1, "width": 1, "height": 1, "dimensionUnit": "INCH" }, "weight": { "value": 1, "weightUnit": "LB" }, "status": "DRAFT", "note": "Gift Box", "createdAt": "2025-07-30T18:32:11.455Z", "updatedAt": "2025-07-30T18:32:11.899Z", "rates": { "postageType": "NEXT DAY", "postageFee": 4.88, "tax": 0.63, "total": 5.51, "currency": "CAD" }, "shipmentLineItems": [ { "description": "T-shirt", "quantity": 1, "unit_value": 10, "currency": "CAD" } ] } }
Una vez que hayas comprado un envío e impreso la etiqueta, visita ship.uniuni.com/locations para confirmar tu ubicación de entrega o ship.uniuni.com/pickups para solicitar un servicio de recolección (si está disponible).
shipmentLineItems es obligatorio. Cada envío debe incluir al menos un artículo (arreglo shipmentLineItems con >= 1 elemento). Omitirlo o enviar un arreglo vacío devuelve un error 422 PayloadValidationError.
Envíos transfronterizos (CA → US): Cada artículo en shipmentLineItems también debe incluir hs_code, country_of_origin y una description que identifique al fabricante. Los envíos que falten esta información pueden ser retenidos en la frontera.

Autorizaciones

​
Authorization
string
header
requerido

API access token generated from the UniUni Platform dashboard.

Cuerpo

application/json
​
recipient
object
requerido
​
address
object
requerido
​
weight
object
requerido
​
shipmentLineItems
object[]
requerido

Line items describing the contents. Must contain at least one item.

Minimum array length: 1
​
dimensions
object

Package dimensions. Provide either dimensions or packagingId, not both.

​
packagingId
integer

ID of a pre-configured packaging profile. Use instead of dimensions if the package matches a saved profile.

​
postageType
enum<string>

Preferred postage type. Domestic shipments typically use SAME DAY, NEXT DAY, or STANDARD. Cross-border CA→US shipments use USPS Ground Advantage (DDP) or PostNL International Packet Tracked (DDU). If the requested type is unavailable, an available type is selected automatically.

Opciones disponibles:
PUBLICATION,
SAME DAY,
NEXT DAY,
STANDARD,
USPS Ground Advantage,
PostNL International Packet Tracked,
OTHER
​
note
string

Optional note, up to 200 characters.

Maximum string length: 200
​
insuranceRequired
boolean

Whether parcel protection (insurance) is required for this shipment.

​
orderNumber
string

Optional client-provided order reference.

Respuesta

Shipment created or error returned

​
message
string
requerido

Additional information about the request status.

​
code
integer
requerido

Status code. 0 indicates success.

​
data
object