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.

Endereços da conta

O seu catálogo de endereços

GET/account-addresses
POST/account-addresses
PATCH/account-addresses/{accountAddressId}

O objeto Endereço da conta

Um endereço salvo de uma conta: um remetente, um destinatário ou ambos.

Atributos

uidstringobrigatórioaceita null
UID do endereço. Use-o como accountAddressId, ou como uid do remetente / destinatário em um envio.
nicknamestringaceita null
Nome exibido nos catálogos de endereços.
namestringaceita null
Nome do contato.
companyNamestringaceita null
Nome da empresa.
taxIdstringaceita null
Documento fiscal do contato.
emailstringaceita null
E-mail do contato.
phonestringaceita null
Telefone do contato, E.164.
birthdaystring <date-time>aceita null
Data de nascimento do contato, quando coletada.
isRecipientboolean | integeraceita null
O endereço pode receber envios. 1/true ou 0/false.
isSenderboolean | integeraceita null
O endereço pode enviar envios. 1/true ou 0/false.
isResidentialboolean | integeraceita null
O endereço é residencial. 1/true ou 0/false.
statusstringobrigatórioaceita null
Status do registro.
addressobjectaceita null
Endereço postal. Incluído quando o endereço é lido sozinho.
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
countryobjectaceita null
País do endereço. Incluído quando o endereço é lido sozinho.
Atributos aninhados
- isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
createdAtstring <date-time>obrigatórioaceita null
Quando o endereço foi salvo.
updatedAtstring <date-time>obrigatórioaceita null
Quando o endereço mudou pela última vez.

O objeto Endereço da conta

{
  "uid": "3cl95vgkut4n",
  "nickname": null,
  "name": null,
  "companyName": null,
  "taxId": null,
  "email": null,
  "phone": null,
  "birthday": null,
  "isRecipient": 0,
  "isSender": 0,
  "isResidential": 0,
  "status": "active",
  "createdAt": "2026-11-01T00:37:55.000Z",
  "updatedAt": "2026-11-01T00:37:55.000Z"
}

Listar o seu catálogo de endereços

GET/account-addresses

Requer um token de acesso

Lista os remetentes e destinatários salvos das suas contas.

Parâmetros de consulta

accountIdstring
Limita os resultados a uma das suas contas: o seu uid, o seu número de conta (CU…) ou o seu número de conta externo. Sem ele, todas as contas das quais você faz parte 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 endereços salvos.

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 Endereço da contaobrigatório
O objeto Endereço da conta

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/account-addresses

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

Resposta

{
  "total": 1,
  "limit": 20,
  "skip": 0,
  "data": [
    {
      "uid": "3cl95vgkut4n",
      "nickname": null,
      "name": null,
      "companyName": null,
      "taxId": null,
      "email": null,
      "phone": null,
      "birthday": null,
      "isRecipient": 0,
      "isSender": 0,
      "isResidential": 0,
      "status": "active",
      "createdAt": "2026-11-01T00:37:55.000Z",
      "updatedAt": "2026-11-01T00:37:55.000Z"
    }
  ]
}

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

Salvar um endereço

POST/account-addresses

Requer um token de acesso

Adiciona um remetente ou destinatário ao catálogo de endereços de uma das suas contas (accountId).

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

useExistingAddressboolean
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
accountIdstringobrigatório

Respostas

201

O endereço salvo

O objeto Endereço da conta

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/account-addresses

curl -X POST 'https://sandbox.weshipyou.com/api/v1/account-addresses' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "useExistingAddress": true,
  "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"
  },
  "accountId": "CU1234567"
}'

Resposta

{
  "uid": "a3neeyyhaytn",
  "nickname": "Warehouse",
  "name": "Jane Doe",
  "companyName": null,
  "email": "jane.doe@example.com",
  "phone": "+1 (305) 555-0100",
  "birthday": null,
  "isRecipient": false,
  "isSender": false,
  "isResidential": false,
  "status": "active",
  "createdAt": "2026-11-01T00:37:55.921Z",
  "updatedAt": "2026-11-01T00:37:55.921Z"
}

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

Atualizar um endereço

PATCH/account-addresses/{accountAddressId}

Requer um token de acesso

Altera os campos que você envia. Enquanto o endereço for usado por um envio em trânsito ou entregue, os seus campos de identidade (nome, telefone, endereço, documento fiscal, …) não podem mudar e a requisição responde 400; salve um novo endereço.

Parâmetros de caminho

accountAddressIdstringobrigatório
O uid do endereço.

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

useExistingAddressboolean
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

Respostas

200

O endereço atualizado

O objeto Endereço da conta

400

Erro de validação, ou um campo bloqueado de um endereço em uso

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

Nenhum envio tem esse id

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

PATCH/account-addresses/{accountAddressId}

curl -X PATCH 'https://sandbox.weshipyou.com/api/v1/account-addresses/{accountAddressId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "useExistingAddress": true,
  "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"
  }
}'

Resposta

{
  "uid": "3cl95vgkut4n",
  "nickname": "Office",
  "name": null,
  "companyName": null,
  "taxId": null,
  "email": null,
  "phone": null,
  "birthday": null,
  "isRecipient": 0,
  "isSender": 0,
  "isResidential": 0,
  "status": "active",
  "createdAt": "2026-11-01T00:37:55.000Z",
  "updatedAt": "2026-11-01T00:37:55.000Z"
}

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