We Ship You

Loja

WeShipYou
Compre produtos selecionados de vendedores WeShipYou, com fulfillment completo e garantia de envio.
Amazon
Compre na Amazon, a maior loja do mundo com a maior variedade de produtos, tudo com a segurança do WeShipYou!
eBay
Itens novos e usados de vendedores dos EUA: compramos para você os anúncios com “Compre já”.
AliExpress
Milhões de produtos a preço de fábrica, comprados e enviados por nós.
Walmart
Compre produtos de farmácia e supermercado no Walmart de forma rápida e fácil!
Shein
Compre os últimos produtos em alta aos melhores preços com desconto, apenas na loja Shein!
Temu
Compre os melhores produtos a preços com desconto na loja Temu!
Shopify
Pesquise em milhares de lojas Shopify dos EUA de uma vez, ou cole um link de qualquer uma delas.

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

Loja

Envios

Crie, cote, etiquete, cancele e confirme os seus envios

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

O objeto Envio

Um envio: o que é enviado, por quem, para quem, e o status da sua etiqueta e da sua entrega.

Atributos

uidstringobrigatório
UID do envio. Use-o como shipmentId.
statestringobrigatório
Estado do ciclo de vida, de created passando por label_created até delivered ou cancelled.
statusTrackingstringaceita null
Último status de rastreamento da transportadora, por extenso.
transactionStatestringaceita null
Estado de cobrança do envio, quando foi cobrado ou reembolsado.
externalReferenceCodestringaceita null
A sua própria referência para o envio.
externalCustomerIdstringaceita null
A sua própria referência de cliente.
externalUniqueIdstringaceita null
A sua própria referência de idempotência.
incotermsstringobrigatório
Quem paga os impostos de importação: o destinatário (DDU) ou o remetente (DDP).
Valores permitidos:DDUDDP
weightUnitstringobrigatório
Unidade de weight.
Valores permitidos:gmkgozlb
dimUnitstringobrigatório
Unidade de length, width e height.
weightnumberaceita null
Peso total.
lengthnumberaceita null
Comprimento da caixa.
widthnumberaceita null
Largura da caixa.
heightnumberaceita null
Altura da caixa.
totalValuenumberaceita null
Valor declarado do conteúdo, USD.
insuranceboolean | integer
O envio tem seguro. 1/true ou 0/false.
insuranceAmountnumberaceita null
Valor segurado, USD.
appliedCouponDiscountnumberaceita null
Desconto de cupom aplicado ao preço da etiqueta, USD.
sellerNotesstringaceita null
Observações do remetente.
buyerNotesstringaceita null
Observações do destinatário.
labelCreatedAtstring <date-time>aceita null
Quando a etiqueta foi comprada.
deliveredAtstring <date-time>aceita null
Quando a transportadora entregou o envio.
cancellationReasonstringaceita null
Por que o envio foi cancelado.
cancellationReasonCodestringaceita null
Código técnico do motivo do cancelamento.
customsAuthorizationsobject
Documentos alfandegários exigidos pelo destino, e se o cliente ainda pode editá-los.
senderobjectaceita null
O remetente. Incluído quando o envio é lido sozinho.
Atributos aninhados
- uidstring
  UID da entrada do catálogo de endereços.
- nicknamestringaceita null
  O seu rótulo para a entrada.
- companyNamestringaceita null
  Nome da empresa.
- namestringaceita null
  Nome completo.
- taxIdstringaceita null
  Documento fiscal.
- emailstringaceita null
  Endereço de e-mail.
- phonestringaceita null
  Número de telefone.
- isResidentialboolean | integer
  Endereço de entrega residencial.
- statusstring
  Status da entrada.
- addressobjectaceita null
  Um endereço postal como a WeShipYou o interpretou.
  Atributos aninhados
  uidstring
  UID do endereço.
  houseNumberstringaceita null
  Número da casa ou do prédio.
  roadstringaceita null
  Nome da rua.
  unitstringaceita null
  Apartamento, sala ou unidade.
  cityobjectaceita null
  Atributos aninhados
  namestring
  Nome da cidade.
  stateobjectaceita null
  Atributos aninhados
  namestring
  isoCodestringaceita null
  Sigla do estado.
  countryobjectaceita null
  Atributos aninhados
  isoCodestring
  namestring
  postal_codeobjectaceita null
  Atributos aninhados
  postalCodestring
recipientobjectaceita null
O destinatário. Incluído quando o envio é lido sozinho.
Atributos aninhados
- uidstring
  UID da entrada do catálogo de endereços.
- nicknamestringaceita null
  O seu rótulo para a entrada.
- companyNamestringaceita null
  Nome da empresa.
- namestringaceita null
  Nome completo.
- taxIdstringaceita null
  Documento fiscal.
- emailstringaceita null
  Endereço de e-mail.
- phonestringaceita null
  Número de telefone.
- isResidentialboolean | integer
  Endereço de entrega residencial.
- statusstring
  Status da entrada.
- addressobjectaceita null
  Um endereço postal como a WeShipYou o interpretou.
  Atributos aninhados
  uidstring
  UID do endereço.
  houseNumberstringaceita null
  Número da casa ou do prédio.
  roadstringaceita null
  Nome da rua.
  unitstringaceita null
  Apartamento, sala ou unidade.
  cityobjectaceita null
  Atributos aninhados
  namestring
  Nome da cidade.
  stateobjectaceita null
  Atributos aninhados
  namestring
  isoCodestringaceita null
  Sigla do estado.
  countryobjectaceita null
  Atributos aninhados
  isoCodestring
  namestring
  postal_codeobjectaceita null
  Atributos aninhados
  postalCodestring
parcelslista de object
Os pacotes e os seus itens. Incluídos quando o envio é lido sozinho.
parcel_rateslista de Tarifa
Os serviços com os quais este envio pode ser enviado e os seus preços. Incluído na resposta de POST /shipments e PATCH /shipments/{shipmentId}; escolha um e compre-o com POST /shipments/labels. O seu totalChargePrice inclui o seguro (insuranceFee) mesmo quando o envio não está segurado; veja o objeto Tarifa.
Atributos aninhados
- uidstringobrigatório
  O id da tarifa. Envie-o como rateId para POST /shipments/labels.
- serviceobject
  O serviço de envio.
  Atributos aninhados
  uidstringaceita null
  O uid do serviço.
  namestringaceita null
  O nome do serviço.
  umbrellaNamestringaceita null
  A transportadora ou a marca à qual o serviço pertence.
  serviceTypestringaceita null
  ground, air ou sea.
- totalChargePricenumber
  O preço cotado. Inclui insuranceFee esteja ou não o envio segurado, e improvedFoamProtectionFee. Subtraia insuranceFee quando o envio não está segurado.
- insuranceFeenumber
  O preço de segurar o envio com este serviço. Já está dentro de totalChargePrice; só é cobrado quando o envio está segurado.
- improvedFoamProtectionFeenumber
  O preço da proteção aprimorada com espuma, já incluído em totalChargePrice. É 0 a menos que o envio a peça.
- shipmentChargeTotalPricenumber
  O preço do serviço de envio sozinho; os descontos de cupons são calculados sobre ele. Não é o custo da etiqueta: veja totalChargePrice.
- pickupFeenumber
  Somado ao preço da etiqueta quando os pacotes são coletados.
- minimumPickupFeenumber
  Somado ao preço da etiqueta quando os pacotes são coletados.
labelobjectaceita null
A etiqueta, depois de comprada. Incluída quando o envio é lido sozinho (GET /shipments/{shipmentId}).
Atributos aninhados
- trackingNumberstringaceita null
  O número de rastreamento da WeShipYou (WSY…). Use-o com GET /tracking/{trackingNumber} e para cancelar a etiqueta.
createdAtstring <date-time>obrigatório
Quando o envio foi criado.
updatedAtstring <date-time>obrigatório
Quando o envio mudou pela última vez.

O objeto Envio

{
  "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"
}

O objeto Categoria

Uma categoria de conteúdo de envio. Cada item de pacote declara uma.

Atributos

uidstringobrigatório
UID da categoria.
namestringobrigatório
Nome de exibição.
slugstringobrigatório
Nome técnico estável.
weightnumberaceita null
Peso padrão de uma unidade, em gramas.
lengthnumberaceita null
Comprimento padrão, em centímetros.
widthnumberaceita null
Largura padrão, em centímetros.
heightnumberaceita null
Altura padrão, em centímetros.
containsDocumentsboolean | integer
Os itens desta categoria são documentos. 1/true ou 0/false.
containsOtherDgboolean | integer
Os itens desta categoria são mercadorias perigosas que não são baterias. 1/true ou 0/false.
containsLiquidsboolean | integer
Os itens desta categoria contêm líquidos. 1/true ou 0/false.
containsBatteryPi967boolean | integer
Baterias de íon-lítio contidas em equipamento (PI 967). 1/true ou 0/false.
containsBatteryPi966boolean | integer
Baterias de íon-lítio embaladas com equipamento (PI 966). 1/true ou 0/false.
containsBatteryPi965boolean | integer
Baterias de íon-lítio avulsas (PI 965). 1/true ou 0/false.
parentIdintegeraceita null
Categoria pai, quando esta é uma subcategoria.

O objeto Categoria

{
  "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
}

O objeto Categoria por país

Atributos

uidstringaceita null
namestringaceita null
slugstringaceita null
weightnumberaceita null
lengthnumberaceita null
widthnumberaceita null
heightnumberaceita null
containsDocumentsbooleanaceita null
containsOtherDgbooleanaceita null
containsLiquidsbooleanaceita null
containsBatteryPi967booleanaceita null
containsBatteryPi966booleanaceita null
containsBatteryPi965booleanaceita null
customsValuenumberaceita null
qtynumberaceita null
maxWeightnumberaceita null
unitTypestringaceita null
observationsstringaceita null
isDiscontinuedbooleanaceita null
createdAtstring <date-time>aceita null
updatedAtstring <date-time>aceita null
parentIdnumberaceita null

O objeto Tarifa

Um serviço com o qual o envio pode ser enviado, e o seu preço em USD.

totalChargePrice sempre inclui o preço do seguro (insuranceFee), mesmo quando o envio não está segurado. Os envios não são segurados a menos que você peça (insurance: true), então na maioria dos casos subtraia insuranceFee para obter o custo da etiqueta:

preço da etiqueta = totalChargePrice − insuranceFee quando o envio não está segurado, ou totalChargePrice quando está;
mais pickupFee e minimumPickupFee quando os pacotes são coletados (handoverOption: "pickup" em POST /shipments/labels).

Um cupom reduz esse preço ainda mais.

Atributos

uidstring
O id da tarifa. Envie-o como rateId para POST /shipments/labels.
serviceobject
O serviço de envio.
Atributos aninhados
- uidstringaceita null
  O uid do serviço.
- namestringaceita null
  O nome do serviço.
- umbrellaNamestringaceita null
  A transportadora ou a marca à qual o serviço pertence.
- serviceTypestringaceita null
  ground, air ou sea.
totalChargePricenumber
O preço cotado. Inclui insuranceFee esteja ou não o envio segurado, e improvedFoamProtectionFee. Subtraia insuranceFee quando o envio não está segurado.
insuranceFeenumber
O preço de segurar o envio com este serviço. Já está dentro de totalChargePrice; só é cobrado quando o envio está segurado.
improvedFoamProtectionFeenumber
O preço da proteção aprimorada com espuma, já incluído em totalChargePrice. É 0 a menos que o envio a peça.
shipmentChargeTotalPricenumber
O preço do serviço de envio sozinho; os descontos de cupons são calculados sobre ele. Não é o custo da etiqueta: veja totalChargePrice.
pickupFeenumber
Somado ao preço da etiqueta quando os pacotes são coletados.
minimumPickupFeenumber
Somado ao preço da etiqueta quando os pacotes são coletados.

O 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 envio

POST/shipments/rates

Requer um token de acesso

Cota todos os serviços disponíveis para um envio. Envie o envio como você o criaria; accountId é opcional. Para cotar pacotes que já estão no seu locker, envie o uid de cada item de GET /forwarder como forwardingOrderItemId em um item do pacote (o exemplo A partir de itens do locker).

O totalChargePrice de cada tarifa inclui o seguro (insuranceFee), mesmo quando você não o pede. Se o envio não for segurado (o padrão), subtraia insuranceFee para obter o preço da sua etiqueta.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

O envio a criar.

accountIdstringobrigatório
- string
  O uid da sua conta, como retornado por POST /authentication.
- string
  O seu número de conta (CU…).
  no máximo 10 caracteres
totalValuenumberobrigatório
<= 2999
insuranceboolean
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstringobrigatório
Valores permitidos:DDUDDP
weightUnitstring
Unidade de weight para cada pacote que não defina seu próprio weightUnit. Sem unidade no pacote nem aqui, os pesos são lidos em gramas.
Valores permitidos:gmkgozlb
dimUnitstring
Unidade de length, width e height para cada pacote que não defina seu próprio dimUnit. Sem unidade no pacote nem aqui, as medidas são lidas em centímetros.
Valores permitidos:cmin
senderobjectobrigatório
Atributos aninhados
- addressobjectobrigatório
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestring
  stateobject
  Atributos aninhados
  namestring
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
- countryobjectobrigatório
  Um país, pelo seu código ISO 3166-1 alfa-2.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
recipientobjectobrigatório
Atributos aninhados
- addressobjectobrigatório
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestring
  stateobject
  Atributos aninhados
  namestring
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
- countryobjectobrigatório
  Um país, pelo seu código ISO 3166-1 alfa-2.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
parcelslista de objectobrigatório
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

201

As tarifas disponíveis. Cada totalChargePrice inclui o seguro (insuranceFee); veja o objeto Tarifa.

O objeto Tarifa

400

Pacotes inválidos, ou um forwardingOrderItemId desconhecido

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

401

Token de acesso ausente ou inválido

namestring
Sempre NotAuthenticated
messagestring
codenumber
Sempre 401
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Exemplos de requisição

{
  "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"
        }
      ]
    }
  ]
}

Resposta

[
  {
    "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
  }
]

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Buscar envios

GET/shipments

Requer um token de acesso

Lista os envios das suas contas.

Parâmetros de consulta

accountIdstring
Limita os resultados a uma das suas contas ou a uma das subcontas delas: o seu uid, o seu número de conta (CU…) ou o seu número de conta externo. Sem ele, as contas das quais você faz parte e todas as subcontas delas são incluídas.
$limitnumber
Número máximo de resultados (padrão 20).
Padrão: 20
>= 0 · <= 500
$skipnumber
Número de resultados a ignorar, para paginação.
Padrão: 0
>= 0

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página dos seus envios.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Envioobrigatório
O objeto Envio

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre forbidden
dataobject

GET/shipments

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

Resposta

{
  "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"
    }
  ]
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Adicionar um novo envio à sua conta

POST/shipments

Requer um token de acesso

Cria um envio (ainda sem etiqueta). accountId aceita o uid da conta, o seu número de conta (CU…) ou o seu número de conta externo. Cote-o com POST /shipments/rates e compre a etiqueta com POST /shipments/labels.

Para enviar pacotes que já estão no seu locker, liste-os com GET /forwarder e envie o uid de cada item como forwardingOrderItemId em um item do pacote (o exemplo A partir de itens do locker).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

O envio a criar.

accountIdstring | integerobrigatório
- string | integer
  O uid da sua conta, como retornado por POST /authentication, ou o uid de uma das subcontas dela (GET /accounts) para enviar em nome dessa subconta.
- string | integer
  O seu número de conta (CU…).
  no máximo 10 caracteres
senderobjectobrigatório
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
recipientobjectobrigatório
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
totalValuenumberobrigatório
<= 2999
externalReferenceCodestring
externalCustomerIdstringaceita null
insuranceboolean | integer
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstringobrigatório
Valores permitidos:DDUDDP
weightUnitstring
Unidade de weight para cada pacote que não defina seu próprio weightUnit. É salva no envio, e o painel mostra o peso do envio nessa unidade. Por padrão, a weightUnit do primeiro pacote.
Valores permitidos:gmkgozlb
dimUnitstring
Unidade de length, width e height para cada pacote que não defina seu próprio dimUnit. É salva no envio. Por padrão, o dimUnit do primeiro pacote.
Valores permitidos:cmin
parcelslista de objectobrigatório
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

201

O envio criado

O objeto Envio

400

Erro de validação; data contém a mensagem de cada campo inválido

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Exemplos de requisição

{
  "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"
        }
      ]
    }
  ]
}

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter um envio

GET/shipments/{shipmentId}

Requer um token de acesso

Retorna um dos seus envios.

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

O envio

O objeto Envio

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

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

GET/shipments/{shipmentId}

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

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Atualizar um envio

PATCH/shipments/{shipmentId}

Requer um token de acesso

Altera os campos que você envia e mantém todos os outros como estão. Para mudar um endereço, envie o objeto sender ou recipient completo (ou { "id": <address id>, "useExistingAddress": true } para usar um do seu catálogo de endereços); para mudar o conteúdo, envie o array parcels completo. As tarifas são recalculadas depois da alteração. Um envio entregue não pode ser editado.

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

Qualquer um dos campos do envio.

accountIdstring
- string
  O uid da sua conta, como retornado por POST /authentication.
- string
  O seu número de conta (CU…).
  no máximo 10 caracteres
senderobject
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
recipientobject
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
totalValuenumber
<= 2999
externalReferenceCodestring
externalCustomerIdstring
insuranceboolean
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstring
Valores permitidos:DDUDDP
parcelslista de object
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

200

O envio atualizado

O objeto Envio

400

Erro de validação, ou o envio não pode mais ser editado

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

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

namestring
Sempre NotFound
messagestring
codenumber
Sempre 404
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Excluir um envio

DELETE/shipments/{shipmentId}

Requer um token de acesso

Exclui um envio que ainda não tem etiqueta (estado created). Para cancelar um envio cuja etiqueta já foi comprada, use DELETE /shipments/labels/{trackingNumber}.

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

O envio excluído

O objeto Envio

400

O envio não pode ser excluído no estado atual

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

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

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

DELETE/shipments/{shipmentId}

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

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter categorias de envio

GET/shipments/categories

Requer um token de acesso

Lista as categorias de conteúdo que um item de pacote pode declarar.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página de categorias de conteúdo de envio.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Categoriaobrigatório
O objeto Categoria

401

Token de acesso ausente ou inválido

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

403

Proibido

GET/shipments/categories

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

Resposta

{
  "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
    }
  ]
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter categorias por país

GET/shipments/country-categories

Requer um token de acesso

Lista as categorias de conteúdo que um país de destino usa na alfândega.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página de categorias de conteúdo por país.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Categoria por paísobrigatório
O objeto Categoria por país

401

Token de acesso ausente ou inválido

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

403

Proibido

GET/shipments/country-categories

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

Resposta

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

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Comprar etiquetas

POST/shipments/labels

Requer um token de acesso

Compra a etiqueta de um ou mais envios pela tarifa que você escolheu. A cobrança é registrada na sua carteira WeShipYou: o seu saldo é usado primeiro e só o restante é cobrado de paymentMethod.

Cada etiqueta custa o totalChargePrice da sua tarifa menos insuranceFee quando o envio não está segurado (as tarifas sempre incluem o seguro), mais pickupFee e minimumPickupFee para uma entrega pickup. Um cupom reduz esse preço ainda mais.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

accountIdstring
uid da conta, número de conta (CU…) ou número de conta externo.
paymentMethod"credit_line" | object
Como pagar o que o saldo da sua carteira não cobre: "credit_line" para contas com linha de crédito, ou um cartão salvo como { "paymentMethodId": "pm_…" }. Pode ser omitido quando o saldo cobre o valor total.
Atributos aninhados
Um de
Valores permitidos:credit_line
paymentMethodIdstring
usePointsboolean
Use primeiro os seus pontos WeShipYou.
insuranceboolean
Segura todos os envios desta compra (true) ou nenhum (false). Deixe de fora para manter o insurance próprio de cada envio.
handoverOptionslista de objectobrigatório
Atributos aninhados
- handoverOptionstringobrigatório
  Valores permitidos:dropoffpickup
- pickupDatestring <date>
- pickupTimestring
- shipmentslista de objectobrigatório
  Atributos aninhados
  shipmentIdstringobrigatório
  uid do envio ou número de rastreamento WeShipYou.
  rateIdstringobrigatório
  O uid da tarifa escolhida para esse envio.

Respostas

201

O resultado de cada lote de etiquetas

statusstringobrigatório
Resultado do lote.
Valores permitidos:fulfilledrejected
reasonany
Por que o lote falhou, quando status é rejected.

400

Requisição inválida, pagamento não encontrado ou saldo insuficiente

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Resposta

[
  {
    "status": "fulfilled"
  }
]

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Cancelar uma etiqueta

DELETE/shipments/labels/{trackingNumber}

Requer um token de acesso

Cancela uma etiqueta que a transportadora ainda não coletou. O valor pago por ela volta como crédito para a sua carteira WeShipYou.

Parâmetros de caminho

trackingNumberstringobrigatório
O número de rastreamento WeShipYou da etiqueta.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

A etiqueta foi cancelada

idstringobrigatório
Número de rastreamento WeShipYou da etiqueta cancelada.

400

A etiqueta não pode mais ser cancelada

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre forbidden
dataobject

404

Não encontrado

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

409

O envio mudou de estado durante o cancelamento; tente de novo

namestring
Sempre Conflict
messagestring
codenumber
Sempre 409
classNamestring
Sempre conflict
dataobject

DELETE/shipments/labels/{trackingNumber}

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

Resposta

{
  "id": "WSYOP5B60J3SCU"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Confirmar uma entrega

POST/shipments/confirm-delivery

Não precisa de token de acesso

Registra que o destinatário recebeu um envio que está em trânsito ou entregue. Não é preciso token de acesso: o número de rastreamento e o número da conta identificam o envio.

Um envio que já está delivered sempre pode ser confirmado. Um envio in_transit só pode ser confirmado quando está atrasado (a etiqueta foi comprada há pelo menos 30 dias e, se ele tem uma data prometida de entrega, passaram pelo menos 15 dias desde essa data) e não chegou à WeShipYou no destino. Quando o pacote já está com a WeShipYou em Cuba (retirado no aeroporto ou no porto, em uma viagem de trânsito ou em uma rota de entrega), só a WeShipYou o marca como entregue. Uma recusa é um 400 com data.code: delivery-confirmation-at-destination, ou delivery-confirmation-too-early com data.availableFrom.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

trackingNumberstringobrigatório
accountNumberstringobrigatório
O número da conta do dono do envio (CU…).

Respostas

201

Entrega registrada

okboolean
Sempre true
idstring
O número de rastreamento.

400

Campos ausentes, conta ou envio desconhecidos, ou um envio que não está em trânsito

namestring
Sempre BadRequest
messagestring
codenumber
Sempre 400
classNamestring
Sempre 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"
}'

Resposta

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

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Envios

Crie, cote, etiquete, cancele e confirme os seus envios

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

O objeto Envio

Um envio: o que é enviado, por quem, para quem, e o status da sua etiqueta e da sua entrega.

Atributos

uidstringobrigatório
UID do envio. Use-o como shipmentId.
statestringobrigatório
Estado do ciclo de vida, de created passando por label_created até delivered ou cancelled.
statusTrackingstringaceita null
Último status de rastreamento da transportadora, por extenso.
transactionStatestringaceita null
Estado de cobrança do envio, quando foi cobrado ou reembolsado.
externalReferenceCodestringaceita null
A sua própria referência para o envio.
externalCustomerIdstringaceita null
A sua própria referência de cliente.
externalUniqueIdstringaceita null
A sua própria referência de idempotência.
incotermsstringobrigatório
Quem paga os impostos de importação: o destinatário (DDU) ou o remetente (DDP).
Valores permitidos:DDUDDP
weightUnitstringobrigatório
Unidade de weight.
Valores permitidos:gmkgozlb
dimUnitstringobrigatório
Unidade de length, width e height.
weightnumberaceita null
Peso total.
lengthnumberaceita null
Comprimento da caixa.
widthnumberaceita null
Largura da caixa.
heightnumberaceita null
Altura da caixa.
totalValuenumberaceita null
Valor declarado do conteúdo, USD.
insuranceboolean | integer
O envio tem seguro. 1/true ou 0/false.
insuranceAmountnumberaceita null
Valor segurado, USD.
appliedCouponDiscountnumberaceita null
Desconto de cupom aplicado ao preço da etiqueta, USD.
sellerNotesstringaceita null
Observações do remetente.
buyerNotesstringaceita null
Observações do destinatário.
labelCreatedAtstring <date-time>aceita null
Quando a etiqueta foi comprada.
deliveredAtstring <date-time>aceita null
Quando a transportadora entregou o envio.
cancellationReasonstringaceita null
Por que o envio foi cancelado.
cancellationReasonCodestringaceita null
Código técnico do motivo do cancelamento.
customsAuthorizationsobject
Documentos alfandegários exigidos pelo destino, e se o cliente ainda pode editá-los.
senderobjectaceita null
O remetente. Incluído quando o envio é lido sozinho.
Atributos aninhados
- uidstring
  UID da entrada do catálogo de endereços.
- nicknamestringaceita null
  O seu rótulo para a entrada.
- companyNamestringaceita null
  Nome da empresa.
- namestringaceita null
  Nome completo.
- taxIdstringaceita null
  Documento fiscal.
- emailstringaceita null
  Endereço de e-mail.
- phonestringaceita null
  Número de telefone.
- isResidentialboolean | integer
  Endereço de entrega residencial.
- statusstring
  Status da entrada.
- addressobjectaceita null
  Um endereço postal como a WeShipYou o interpretou.
  Atributos aninhados
  uidstring
  UID do endereço.
  houseNumberstringaceita null
  Número da casa ou do prédio.
  roadstringaceita null
  Nome da rua.
  unitstringaceita null
  Apartamento, sala ou unidade.
  cityobjectaceita null
  Atributos aninhados
  namestring
  Nome da cidade.
  stateobjectaceita null
  Atributos aninhados
  namestring
  isoCodestringaceita null
  Sigla do estado.
  countryobjectaceita null
  Atributos aninhados
  isoCodestring
  namestring
  postal_codeobjectaceita null
  Atributos aninhados
  postalCodestring
recipientobjectaceita null
O destinatário. Incluído quando o envio é lido sozinho.
Atributos aninhados
- uidstring
  UID da entrada do catálogo de endereços.
- nicknamestringaceita null
  O seu rótulo para a entrada.
- companyNamestringaceita null
  Nome da empresa.
- namestringaceita null
  Nome completo.
- taxIdstringaceita null
  Documento fiscal.
- emailstringaceita null
  Endereço de e-mail.
- phonestringaceita null
  Número de telefone.
- isResidentialboolean | integer
  Endereço de entrega residencial.
- statusstring
  Status da entrada.
- addressobjectaceita null
  Um endereço postal como a WeShipYou o interpretou.
  Atributos aninhados
  uidstring
  UID do endereço.
  houseNumberstringaceita null
  Número da casa ou do prédio.
  roadstringaceita null
  Nome da rua.
  unitstringaceita null
  Apartamento, sala ou unidade.
  cityobjectaceita null
  Atributos aninhados
  namestring
  Nome da cidade.
  stateobjectaceita null
  Atributos aninhados
  namestring
  isoCodestringaceita null
  Sigla do estado.
  countryobjectaceita null
  Atributos aninhados
  isoCodestring
  namestring
  postal_codeobjectaceita null
  Atributos aninhados
  postalCodestring
parcelslista de object
Os pacotes e os seus itens. Incluídos quando o envio é lido sozinho.
parcel_rateslista de Tarifa
Os serviços com os quais este envio pode ser enviado e os seus preços. Incluído na resposta de POST /shipments e PATCH /shipments/{shipmentId}; escolha um e compre-o com POST /shipments/labels. O seu totalChargePrice inclui o seguro (insuranceFee) mesmo quando o envio não está segurado; veja o objeto Tarifa.
Atributos aninhados
- uidstringobrigatório
  O id da tarifa. Envie-o como rateId para POST /shipments/labels.
- serviceobject
  O serviço de envio.
  Atributos aninhados
  uidstringaceita null
  O uid do serviço.
  namestringaceita null
  O nome do serviço.
  umbrellaNamestringaceita null
  A transportadora ou a marca à qual o serviço pertence.
  serviceTypestringaceita null
  ground, air ou sea.
- totalChargePricenumber
  O preço cotado. Inclui insuranceFee esteja ou não o envio segurado, e improvedFoamProtectionFee. Subtraia insuranceFee quando o envio não está segurado.
- insuranceFeenumber
  O preço de segurar o envio com este serviço. Já está dentro de totalChargePrice; só é cobrado quando o envio está segurado.
- improvedFoamProtectionFeenumber
  O preço da proteção aprimorada com espuma, já incluído em totalChargePrice. É 0 a menos que o envio a peça.
- shipmentChargeTotalPricenumber
  O preço do serviço de envio sozinho; os descontos de cupons são calculados sobre ele. Não é o custo da etiqueta: veja totalChargePrice.
- pickupFeenumber
  Somado ao preço da etiqueta quando os pacotes são coletados.
- minimumPickupFeenumber
  Somado ao preço da etiqueta quando os pacotes são coletados.
labelobjectaceita null
A etiqueta, depois de comprada. Incluída quando o envio é lido sozinho (GET /shipments/{shipmentId}).
Atributos aninhados
- trackingNumberstringaceita null
  O número de rastreamento da WeShipYou (WSY…). Use-o com GET /tracking/{trackingNumber} e para cancelar a etiqueta.
createdAtstring <date-time>obrigatório
Quando o envio foi criado.
updatedAtstring <date-time>obrigatório
Quando o envio mudou pela última vez.

O objeto Envio

{
  "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"
}

O objeto Categoria

Uma categoria de conteúdo de envio. Cada item de pacote declara uma.

Atributos

uidstringobrigatório
UID da categoria.
namestringobrigatório
Nome de exibição.
slugstringobrigatório
Nome técnico estável.
weightnumberaceita null
Peso padrão de uma unidade, em gramas.
lengthnumberaceita null
Comprimento padrão, em centímetros.
widthnumberaceita null
Largura padrão, em centímetros.
heightnumberaceita null
Altura padrão, em centímetros.
containsDocumentsboolean | integer
Os itens desta categoria são documentos. 1/true ou 0/false.
containsOtherDgboolean | integer
Os itens desta categoria são mercadorias perigosas que não são baterias. 1/true ou 0/false.
containsLiquidsboolean | integer
Os itens desta categoria contêm líquidos. 1/true ou 0/false.
containsBatteryPi967boolean | integer
Baterias de íon-lítio contidas em equipamento (PI 967). 1/true ou 0/false.
containsBatteryPi966boolean | integer
Baterias de íon-lítio embaladas com equipamento (PI 966). 1/true ou 0/false.
containsBatteryPi965boolean | integer
Baterias de íon-lítio avulsas (PI 965). 1/true ou 0/false.
parentIdintegeraceita null
Categoria pai, quando esta é uma subcategoria.

O objeto Categoria

{
  "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
}

O objeto Categoria por país

Atributos

uidstringaceita null
namestringaceita null
slugstringaceita null
weightnumberaceita null
lengthnumberaceita null
widthnumberaceita null
heightnumberaceita null
containsDocumentsbooleanaceita null
containsOtherDgbooleanaceita null
containsLiquidsbooleanaceita null
containsBatteryPi967booleanaceita null
containsBatteryPi966booleanaceita null
containsBatteryPi965booleanaceita null
customsValuenumberaceita null
qtynumberaceita null
maxWeightnumberaceita null
unitTypestringaceita null
observationsstringaceita null
isDiscontinuedbooleanaceita null
createdAtstring <date-time>aceita null
updatedAtstring <date-time>aceita null
parentIdnumberaceita null

O objeto Tarifa

Um serviço com o qual o envio pode ser enviado, e o seu preço em USD.

preço da etiqueta = totalChargePrice − insuranceFee quando o envio não está segurado, ou totalChargePrice quando está;
mais pickupFee e minimumPickupFee quando os pacotes são coletados (handoverOption: "pickup" em POST /shipments/labels).

Um cupom reduz esse preço ainda mais.

Atributos

uidstring
O id da tarifa. Envie-o como rateId para POST /shipments/labels.
serviceobject
O serviço de envio.
Atributos aninhados
- uidstringaceita null
  O uid do serviço.
- namestringaceita null
  O nome do serviço.
- umbrellaNamestringaceita null
  A transportadora ou a marca à qual o serviço pertence.
- serviceTypestringaceita null
  ground, air ou sea.
totalChargePricenumber
O preço cotado. Inclui insuranceFee esteja ou não o envio segurado, e improvedFoamProtectionFee. Subtraia insuranceFee quando o envio não está segurado.
insuranceFeenumber
O preço de segurar o envio com este serviço. Já está dentro de totalChargePrice; só é cobrado quando o envio está segurado.
improvedFoamProtectionFeenumber
O preço da proteção aprimorada com espuma, já incluído em totalChargePrice. É 0 a menos que o envio a peça.
shipmentChargeTotalPricenumber
O preço do serviço de envio sozinho; os descontos de cupons são calculados sobre ele. Não é o custo da etiqueta: veja totalChargePrice.
pickupFeenumber
Somado ao preço da etiqueta quando os pacotes são coletados.
minimumPickupFeenumber
Somado ao preço da etiqueta quando os pacotes são coletados.

O 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 envio

POST/shipments/rates

Requer um token de acesso

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

O envio a criar.

accountIdstringobrigatório
- string
  O uid da sua conta, como retornado por POST /authentication.
- string
  O seu número de conta (CU…).
  no máximo 10 caracteres
totalValuenumberobrigatório
<= 2999
insuranceboolean
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstringobrigatório
Valores permitidos:DDUDDP
weightUnitstring
Unidade de weight para cada pacote que não defina seu próprio weightUnit. Sem unidade no pacote nem aqui, os pesos são lidos em gramas.
Valores permitidos:gmkgozlb
dimUnitstring
Unidade de length, width e height para cada pacote que não defina seu próprio dimUnit. Sem unidade no pacote nem aqui, as medidas são lidas em centímetros.
Valores permitidos:cmin
senderobjectobrigatório
Atributos aninhados
- addressobjectobrigatório
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestring
  stateobject
  Atributos aninhados
  namestring
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
- countryobjectobrigatório
  Um país, pelo seu código ISO 3166-1 alfa-2.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
recipientobjectobrigatório
Atributos aninhados
- addressobjectobrigatório
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestring
  stateobject
  Atributos aninhados
  namestring
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
- countryobjectobrigatório
  Um país, pelo seu código ISO 3166-1 alfa-2.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
parcelslista de objectobrigatório
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

201

As tarifas disponíveis. Cada totalChargePrice inclui o seguro (insuranceFee); veja o objeto Tarifa.

O objeto Tarifa

400

Pacotes inválidos, ou um forwardingOrderItemId desconhecido

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

401

Token de acesso ausente ou inválido

namestring
Sempre NotAuthenticated
messagestring
codenumber
Sempre 401
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Exemplos de requisição

{
  "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"
        }
      ]
    }
  ]
}

Resposta

[
  {
    "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
  }
]

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Buscar envios

GET/shipments

Requer um token de acesso

Lista os envios das suas contas.

Parâmetros de consulta

accountIdstring
Limita os resultados a uma das suas contas ou a uma das subcontas delas: o seu uid, o seu número de conta (CU…) ou o seu número de conta externo. Sem ele, as contas das quais você faz parte e todas as subcontas delas são incluídas.
$limitnumber
Número máximo de resultados (padrão 20).
Padrão: 20
>= 0 · <= 500
$skipnumber
Número de resultados a ignorar, para paginação.
Padrão: 0
>= 0

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página dos seus envios.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Envioobrigatório
O objeto Envio

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre forbidden
dataobject

GET/shipments

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

Resposta

{
  "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"
    }
  ]
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Adicionar um novo envio à sua conta

POST/shipments

Requer um token de acesso

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

O envio a criar.

accountIdstring | integerobrigatório
- string | integer
  O uid da sua conta, como retornado por POST /authentication, ou o uid de uma das subcontas dela (GET /accounts) para enviar em nome dessa subconta.
- string | integer
  O seu número de conta (CU…).
  no máximo 10 caracteres
senderobjectobrigatório
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
recipientobjectobrigatório
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
totalValuenumberobrigatório
<= 2999
externalReferenceCodestring
externalCustomerIdstringaceita null
insuranceboolean | integer
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstringobrigatório
Valores permitidos:DDUDDP
weightUnitstring
Unidade de weight para cada pacote que não defina seu próprio weightUnit. É salva no envio, e o painel mostra o peso do envio nessa unidade. Por padrão, a weightUnit do primeiro pacote.
Valores permitidos:gmkgozlb
dimUnitstring
Unidade de length, width e height para cada pacote que não defina seu próprio dimUnit. É salva no envio. Por padrão, o dimUnit do primeiro pacote.
Valores permitidos:cmin
parcelslista de objectobrigatório
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

201

O envio criado

O objeto Envio

400

Erro de validação; data contém a mensagem de cada campo inválido

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Exemplos de requisição

{
  "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"
        }
      ]
    }
  ]
}

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter um envio

GET/shipments/{shipmentId}

Requer um token de acesso

Retorna um dos seus envios.

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

O envio

O objeto Envio

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

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

GET/shipments/{shipmentId}

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

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Atualizar um envio

PATCH/shipments/{shipmentId}

Requer um token de acesso

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

Qualquer um dos campos do envio.

accountIdstring
- string
  O uid da sua conta, como retornado por POST /authentication.
- string
  O seu número de conta (CU…).
  no máximo 10 caracteres
senderobject
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
recipientobject
Atributos aninhados
- useExistingAddressbooleanobrigatório
Um de
useExistingAddressboolean
Sempre false
nicknamestringaceita null
addressobjectobrigatório
Atributos aninhados
cityobject
Atributos aninhados
namestringaceita null
stateobject
Atributos aninhados
namestringaceita null
streetstring
Endereço, incluindo o número do prédio ou apartamento.
postalCodestring
namestringobrigatórioaceita null
pelo menos 1 caracteres
companyNamestringaceita null
taxIdstringaceita null
taxIdCountryobject
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
phonestring <phone>obrigatórioaceita null
pelo menos 1 caracteres
emailstring <email>obrigatórioaceita null
E-mail do destinatário
countryobjectobrigatório
Um país, pelo seu código ISO 3166-1 alfa-2.
Atributos aninhados
isoCodestring
Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
exatamente 2 caracteres
useExistingAddressboolean
addressobjectobrigatório
Atributos aninhados
idnumber <int64>
ID do endereço
totalValuenumber
<= 2999
externalReferenceCodestring
externalCustomerIdstring
insuranceboolean
Segura o envio. O padrão é false. As tarifas sempre incluem o preço do seguro (insuranceFee) em totalChargePrice; ele só é cobrado quando isto é true.
incotermsstring
Valores permitidos:DDUDDP
parcelslista de object
pelo menos 1 itens · no máximo 100 itens
Atributos aninhados
- dimUnitstringobrigatório
  Unidade de length, width e height.
  Valores permitidos:cmin
- widthnumberobrigatório
- lengthnumberobrigatório
- heightnumberobrigatório
- weightUnitstringobrigatório
  Unidade de weight.
  Valores permitidos:gmkgozlb
  Padrão: gm
- weightnumberobrigatório
  >= 0.01
- parcel_itemslista de objectobrigatório
  pelo menos 1 itens · no máximo 100 itens
  Atributos aninhados
  skustring
  forwardingOrderItemIdstring
  Envia um pacote que já está no seu locker: o uid do item do pedido de redirecionamento, como listado por GET /forwarder. O item deve pertencer à conta do envio. O seu peso e a sua quantidade, e o seu valor declarado quando o tem, são lidos do locker, e as dimensões do pacote são recalculadas a partir do seu peso. Um uid desconhecido, ou um item de outra conta, é um 400.
  descriptionstringobrigatório
  pelo menos 1 caracteres
  categoryobjectobrigatório
  Atributos aninhados
  slugstringobrigatório
  pricenumberobrigatório
  qtynumberobrigatório
  originCountryobject
  Atributos aninhados
  isoCodestring
  pelo menos 2 caracteres
  weightnumber
  currencystring | Currencyobrigatório
  Moeda do valor do item: um código ISO 4217 ou um objeto de moeda.
  Atributos aninhados
  Um de

Respostas

200

O envio atualizado

O objeto Envio

400

Erro de validação, ou o envio não pode mais ser editado

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

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

namestring
Sempre NotFound
messagestring
codenumber
Sempre 404
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Excluir um envio

DELETE/shipments/{shipmentId}

Requer um token de acesso

Exclui um envio que ainda não tem etiqueta (estado created). Para cancelar um envio cuja etiqueta já foi comprada, use DELETE /shipments/labels/{trackingNumber}.

Parâmetros de caminho

shipmentIdstringobrigatório
O uid do envio, ou o seu número de rastreamento WeShipYou (WSY…).

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

O envio excluído

O objeto Envio

400

O envio não pode ser excluído no estado atual

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

401

Token de acesso ausente ou inválido

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

404

Nenhum envio tem esse id

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

DELETE/shipments/{shipmentId}

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

Resposta

{
  "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"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter categorias de envio

GET/shipments/categories

Requer um token de acesso

Lista as categorias de conteúdo que um item de pacote pode declarar.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página de categorias de conteúdo de envio.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Categoriaobrigatório
O objeto Categoria

401

Token de acesso ausente ou inválido

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

403

Proibido

GET/shipments/categories

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

Resposta

{
  "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
    }
  ]
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter categorias por país

GET/shipments/country-categories

Requer um token de acesso

Lista as categorias de conteúdo que um país de destino usa na alfândega.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página de categorias de conteúdo por país.

totalintegerobrigatório
Número total de registros encontrados.
limitintegerobrigatório
Tamanho de página usado nesta resposta.
skipintegerobrigatório
Número de registros ignorados antes desta página.
datalista de Categoria por paísobrigatório
O objeto Categoria por país

401

Token de acesso ausente ou inválido

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

403

Proibido

GET/shipments/country-categories

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

Resposta

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

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Comprar etiquetas

POST/shipments/labels

Requer um token de acesso

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

accountIdstring
uid da conta, número de conta (CU…) ou número de conta externo.
paymentMethod"credit_line" | object
Como pagar o que o saldo da sua carteira não cobre: "credit_line" para contas com linha de crédito, ou um cartão salvo como { "paymentMethodId": "pm_…" }. Pode ser omitido quando o saldo cobre o valor total.
Atributos aninhados
Um de
Valores permitidos:credit_line
paymentMethodIdstring
usePointsboolean
Use primeiro os seus pontos WeShipYou.
insuranceboolean
Segura todos os envios desta compra (true) ou nenhum (false). Deixe de fora para manter o insurance próprio de cada envio.
handoverOptionslista de objectobrigatório
Atributos aninhados
- handoverOptionstringobrigatório
  Valores permitidos:dropoffpickup
- pickupDatestring <date>
- pickupTimestring
- shipmentslista de objectobrigatório
  Atributos aninhados
  shipmentIdstringobrigatório
  uid do envio ou número de rastreamento WeShipYou.
  rateIdstringobrigatório
  O uid da tarifa escolhida para esse envio.

Respostas

201

O resultado de cada lote de etiquetas

statusstringobrigatório
Resultado do lote.
Valores permitidos:fulfilledrejected
reasonany
Por que o lote falhou, quando status é rejected.

400

Requisição inválida, pagamento não encontrado ou saldo insuficiente

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre 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"
        }
      ]
    }
  ]
}'

Resposta

[
  {
    "status": "fulfilled"
  }
]

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Cancelar uma etiqueta

DELETE/shipments/labels/{trackingNumber}

Requer um token de acesso

Cancela uma etiqueta que a transportadora ainda não coletou. O valor pago por ela volta como crédito para a sua carteira WeShipYou.

Parâmetros de caminho

trackingNumberstringobrigatório
O número de rastreamento WeShipYou da etiqueta.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

A etiqueta foi cancelada

idstringobrigatório
Número de rastreamento WeShipYou da etiqueta cancelada.

400

A etiqueta não pode mais ser cancelada

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

401

Token de acesso ausente ou inválido

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

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre forbidden
dataobject

404

Não encontrado

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

409

O envio mudou de estado durante o cancelamento; tente de novo

namestring
Sempre Conflict
messagestring
codenumber
Sempre 409
classNamestring
Sempre conflict
dataobject

DELETE/shipments/labels/{trackingNumber}

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

Resposta

{
  "id": "WSYOP5B60J3SCU"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Confirmar uma entrega

POST/shipments/confirm-delivery

Não precisa de token de acesso

Registra que o destinatário recebeu um envio que está em trânsito ou entregue. Não é preciso token de acesso: o número de rastreamento e o número da conta identificam o envio.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Corpo da requisiçãoapplication/json

trackingNumberstringobrigatório
accountNumberstringobrigatório
O número da conta do dono do envio (CU…).

Respostas

201

Entrega registrada

okboolean
Sempre true
idstring
O número de rastreamento.

400

Campos ausentes, conta ou envio desconhecidos, ou um envio que não está em trânsito

namestring
Sempre BadRequest
messagestring
codenumber
Sempre 400
classNamestring
Sempre 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"
}'

Resposta

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

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.