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.

Contas

As suas contas

GET/accounts
GET/accounts/{accountId}
PATCH/accounts/{accountId}

O objeto Conta

Atributos

namestringobrigatório
pelo menos 1 caracteres
displayNamestringobrigatório
pelo menos 1 caracteres
systemUnitsstringobrigatório
Valores permitidos:imperialmetric
emailstringobrigatório
pelo menos 1 caracteres
notificationEmailstringobrigatório
pelo menos 1 caracteres
websitestringobrigatórioaceita null
phonestringobrigatórioaceita null
pelo menos 1 caracteres
emergencyPhonestringobrigatórioaceita null
pelo menos 1 caracteres
taxIdstringaceita null
taxIdCountryobjectaceita null
Atributos aninhados
- isoCodestringobrigatório
uidstringsomente leitura
accountNumberstringsomente leitura
parentUidstringaceita nullsomente leitura
O uid da conta principal quando esta é uma subconta; null caso contrário.
statusstringsomente leitura
languagestringobrigatório
isBusinessboolean | integerobrigatório
allowBankAccountPaymentsboolean | integersomente leitura
metadataobjectaceita nullsomente leitura
createdAtstring <date-time>somente leitura
updatedAtstring <date-time>somente leitura
deletedAtstring <date-time>aceita nullsomente leitura
addressIdnumberaceita nullsomente leitura
billingAddressIdnumberaceita nullsomente leitura
defaultShipFromIdnumberaceita nullsomente leitura
defaultAddressOnLabelIdnumberaceita nullsomente leitura
defaultReturnAddressIdnumberaceita nullsomente leitura
primaryPaymentShipmentsIdnumberaceita nullsomente leitura
logoIdnumberaceita nullsomente leitura
pickupServiceFallbackIdnumberaceita nullsomente leitura
revisionnumberaceita nullsomente leitura
addressEndereço da conta | object
Endereço principal da conta.
Atributos aninhados
Um de
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 Conta

{
  "name": "Acme Imports",
  "displayName": "Acme Imports",
  "systemUnits": "metric",
  "email": "jane.doe@example.com",
  "notificationEmail": "jane.doe@example.com",
  "website": null,
  "phone": null,
  "emergencyPhone": null,
  "taxId": null,
  "uid": "h4jupn7wtfqp",
  "accountNumber": "000ACC1X16",
  "parentUid": null,
  "status": "active",
  "language": "en",
  "isBusiness": 0,
  "createdAt": "2026-11-01T00:37:55.000Z",
  "updatedAt": "2026-11-01T00:37:55.000Z",
  "deletedAt": null,
  "addressId": null,
  "billingAddressId": null,
  "defaultShipFromId": null,
  "defaultAddressOnLabelId": null,
  "defaultReturnAddressId": null,
  "primaryPaymentShipmentsId": null,
  "pickupServiceFallbackId": null,
  "revision": null
}

Listar as suas contas

GET/accounts

Requer um token de acesso

Lista as contas das quais você faz parte e as subcontas delas. Cada conta indica a sua conta principal em parentUid (null em uma conta da qual você faz parte diretamente), então ?parentUid= lista as subcontas de uma conta.

Parâmetros de consulta

$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
parentUidstring
Somente as subcontas desta conta: o seu uid, o seu número de conta (CU…) ou o seu número de conta externo. Uma conta à qual você não tem acesso retorna uma lista vazia.

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 contas

totalnumber
limitnumber
skipnumber
datalista de Conta
O objeto Conta

401

Token de acesso ausente ou inválido

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

GET/accounts

curl 'https://sandbox.weshipyou.com/api/v1/accounts?parentUid=h4jupn7wtfqp' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Resposta

{
  "total": 2,
  "limit": 20,
  "skip": 0,
  "data": [
    {
      "name": "Acme Imports",
      "displayName": "Acme Imports",
      "systemUnits": "metric",
      "email": "jane.doe@example.com",
      "notificationEmail": "jane.doe@example.com",
      "website": null,
      "phone": null,
      "emergencyPhone": null,
      "taxId": null,
      "uid": "h4jupn7wtfqp",
      "accountNumber": "000ACC1X16",
      "parentUid": null,
      "status": "active",
      "language": "en",
      "isBusiness": 0,
      "createdAt": "2026-11-01T00:37:55.000Z",
      "updatedAt": "2026-11-01T00:37:55.000Z",
      "deletedAt": null,
      "addressId": null,
      "billingAddressId": null,
      "defaultShipFromId": null,
      "defaultAddressOnLabelId": null,
      "defaultReturnAddressId": null,
      "primaryPaymentShipmentsId": null,
      "pickupServiceFallbackId": null,
      "revision": null
    },
    {
      "name": "Acme Imports Orlando",
      "displayName": "Acme Imports Orlando",
      "systemUnits": "imperial",
      "email": "orlando@example.com",
      "notificationEmail": "orlando@example.com",
      "website": null,
      "phone": "+13055550100",
      "emergencyPhone": "+13055550101",
      "taxId": null,
      "uid": "85js5f5clt2u",
      "accountNumber": "CUDHMFEDA9",
      "parentUid": "h4jupn7wtfqp",
      "status": "active",
      "language": "en",
      "isBusiness": 1,
      "createdAt": "2026-11-01T00:40:12.000Z",
      "updatedAt": "2026-11-01T00:40:12.000Z",
      "deletedAt": null,
      "addressId": null,
      "billingAddressId": null,
      "defaultShipFromId": null,
      "defaultAddressOnLabelId": null,
      "defaultReturnAddressId": null,
      "primaryPaymentShipmentsId": null,
      "pickupServiceFallbackId": null,
      "revision": 1
    }
  ]
}

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

Obter uma conta

GET/accounts/{accountId}

Requer um token de acesso

Parâmetros de caminho

accountIdstringobrigatório
uid da conta, número de conta (CU…) ou número de conta externo, de uma conta da qual você faz parte ou de uma das subcontas dela.

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 conta

O objeto Conta

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/accounts/{accountId}

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

Resposta

{
  "name": "Acme Imports",
  "displayName": "Acme Imports",
  "systemUnits": "metric",
  "email": "jane.doe@example.com",
  "notificationEmail": "jane.doe@example.com",
  "website": null,
  "phone": null,
  "emergencyPhone": null,
  "taxId": null,
  "uid": "h4jupn7wtfqp",
  "accountNumber": "000ACC1X16",
  "parentUid": null,
  "status": "active",
  "language": "en",
  "isBusiness": 0,
  "createdAt": "2026-11-01T00:37:55.000Z",
  "updatedAt": "2026-11-01T00:37:55.000Z",
  "deletedAt": null,
  "addressId": null,
  "billingAddressId": null,
  "defaultShipFromId": null,
  "defaultAddressOnLabelId": null,
  "defaultReturnAddressId": null,
  "primaryPaymentShipmentsId": null,
  "pickupServiceFallbackId": null,
  "revision": null
}

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

Atualizar uma conta

PATCH/accounts/{accountId}

Requer um token de acesso

Altera os campos de perfil que você envia (nome, dados de contato, idioma, unidades).

Parâmetros de caminho

accountIdstringobrigatório
uid da conta, número de conta (CU…) ou número de conta externo, de uma conta da qual você faz parte ou de uma das subcontas dela.

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

namestring
pelo menos 1 caracteres
displayNamestring
pelo menos 1 caracteres
systemUnitsstring
Valores permitidos:imperialmetric
emailstring
pelo menos 1 caracteres
notificationEmailstring
pelo menos 1 caracteres
websitestring
phonestring
pelo menos 1 caracteres
emergencyPhonestring
pelo menos 1 caracteres
taxIdstring
taxIdCountryobjectaceita null
Atributos aninhados
- isoCodestringobrigatório
languagestring
isBusinessboolean
addressobject
Atributos aninhados
- 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

A conta atualizada

O objeto Conta

400

Requisição inválida

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/accounts/{accountId}

curl -X PATCH 'https://sandbox.weshipyou.com/api/v1/accounts/{accountId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Jane'\''s Store",
  "notificationEmail": "orders@janesstore.com",
  "phone": "+1 (786) 651-0451"
}'

Resposta

{
  "name": "Acme Imports",
  "displayName": "Contract Store",
  "systemUnits": "metric",
  "email": "jane.doe@example.com",
  "notificationEmail": "jane.doe@example.com",
  "website": null,
  "phone": null,
  "emergencyPhone": null,
  "taxId": null,
  "uid": "h4jupn7wtfqp",
  "accountNumber": "000ACC1X16",
  "parentUid": null,
  "status": "active",
  "language": "en",
  "isBusiness": 0,
  "allowBankAccountPayments": 0,
  "metadata": {
    "ip": "127.0.0.1",
    "method": "patch",
    "path": "v1/accounts",
    "userId": 1,
    "editedVia": "rest",
    "serviceProvider": "rest",
    "date": "2026-11-01T00:37:55.396Z"
  },
  "createdAt": "2026-11-01T00:37:55.000Z",
  "updatedAt": "2026-11-01T00:37:55.000Z",
  "deletedAt": null,
  "addressId": null,
  "billingAddressId": null,
  "defaultShipFromId": null,
  "defaultAddressOnLabelId": null,
  "defaultReturnAddressId": null,
  "primaryPaymentShipmentsId": null,
  "logoId": null,
  "pickupServiceFallbackId": null,
  "revision": 1
}

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