Quick security check

Check the box so we know it’s really you.

Protected by Cloudflare. This keeps bots from creating fake accounts.

We Ship YouAnythingAnywhere
  • Shop
  • Mobile APP
  • Docs
  • Pricing
  • About Us
  • Shop
    • WeShipYou

      Shop curated products from WeShipYou sellers, fulfilled end-to-end with our shipping guarantee.

    • Amazon

      Shop on Amazon, the world's largest store with the widest range of products, all with the security of WeShipYou!

    • eBay

      New and used items from US sellers: we buy Buy It Now listings for you.

    • AliExpress

      Millions of products at factory prices, bought and shipped by us.

    • Walmart

      Shop pharmacy and grocery products at Walmart quickly and easily!

    • Shein

      Shop the latest trending products at the best discounted prices, only at the Shein store!

    • Temu

      Shop the best products at discounted prices at the Temu store!

    • Shopify

      Search thousands of US Shopify stores at once, or paste a link from any of them.

  • Download Mobile APP
    • FulfillmentNew

      Receiving, storage, same-day pick & pack, multi-carrier shipping and returns — handled by us.

    • Price comparator

      Compare and select the shipping service based on your interest fast and easy

    • Shop integrations

      Shopify app, public API and more — plug WeShipYou into your store.

    • API

      API Access for developers

    • Invoicing

      Automatic monthly invoices, branded PDFs and one-click payments.

  • Docs
  • Pricing
  • About us
  • Recharges to Mexico
  • Recharges to Colombia

Join our newsletter!

No spam, guaranteed.

Miami, FL — United States Warehouse

1940 NW 70th Ave, Miami, FL 33126

Get Directions
Follow us
GroupChannel
RechargesRecharge to MexicoRecharge to ColombiaRecharge to JamaicaRecharge to Nicaragua
ShippingSend a packageFulfillment serviceShop integrationsInvoicingShip to ColombiaShip to BrazilShip to MexicoLocker for Colombia
ResourcesDownload APPApiCommercial Assistance
CompanyAbout
Careers
Hiring
Become an AffiliateSupportContact us
Shop
WeShipYou
Amazon
eBay
AliExpress
Walmart
Shein
Temu
Shopify

WeShipYou is proud to be PCI-compliant certified, ensuring the highest standards of payment security and data protection

© We Ship You Corp. Terms of service · Privacy Policy · Legal

The WeShipYou logo and the name "WeShipYou" are registered trademarks of We Ship You Corp

Theme
WeShipYou
  • Overview
Authentication process
  • Authentication
General
  • Shipments
  • Tracking
  • Services
Forwarder
  • Forwarder
Mobile Recharges
  • Mobile Recharges
Account
  • Accounts
  • Account Addresses
    • The Account address object
    • GETList your address book
    • POSTSave an address
    • PATCHUpdate an address
  • Transactions
  • Add Funds
  • Add Sub Account
Download the OpenAPI spec
Menu
  • Overview
Authentication process
  • Authentication
General
  • Shipments
  • Tracking
  • Services
Forwarder
  • Forwarder
Mobile Recharges
  • Mobile Recharges
Account
  • Accounts
  • Account Addresses
    • The Account address object
    • GETList your address book
    • POSTSave an address
    • PATCHUpdate an address
  • Transactions
  • Add Funds
  • Add Sub Account
Download the OpenAPI spec

Account Addresses

Your address book

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

The Account address object

A saved address of an account: a sender, a recipient or both.

Attributes

  • uidstringrequirednullable

    Address UID. Use it as accountAddressId, or as a sender / recipient uid on a shipment.

  • nicknamestringnullable

    Name shown in address books.

  • namestringnullable

    Contact name.

  • companyNamestringnullable

    Company name.

  • taxIdstringnullable

    Tax ID of the contact.

  • emailstringnullable

    Contact email.

  • phonestringnullable

    Contact phone, E.164.

  • birthdaystring <date-time>nullable

    Contact birthday, when collected.

  • isRecipientboolean | integernullable

    The address can receive shipments. 1/true or 0/false.

  • isSenderboolean | integernullable

    The address can send shipments. 1/true or 0/false.

  • isResidentialboolean | integernullable

    The address is residential. 1/true or 0/false.

  • statusstringrequirednullable

    Record status.

  • addressobjectnullable

    Street address. Included when the address is read on its own.

    Child attributes
    • cityobject
      Child attributes
      • namestringnullable
      • stateobject
        Child attributes
        • namestringnullable
    • streetstring

      Street address, including the building or apartment number.

    • postalCodestring
  • countryobjectnullable

    Country of the address. Included when the address is read on its own.

    Child attributes
    • isoCodestring
      Allowed values:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
      exactly 2 characters
  • createdAtstring <date-time>requirednullable

    When the address was saved.

  • updatedAtstring <date-time>requirednullable

    When the address last changed.

The Account address object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "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"
}

List your address book

GET/account-addresses
Requires an access token

Lists the saved senders and recipients of your accounts.

Query parameters

  • accountIdstring

    Limit the results to one of your accounts: its uid, its account number (CU…) or its external account number. Without it, all the accounts you belong to are included.

  • $limitnumber

    Maximum number of results (default 20).

    Default: 20
    >= 0 · <= 500
  • $skipnumber

    Number of results to skip, for paging.

    Default: 0
    >= 0

Header parameters

  • Accept-Languagestring

    Two-letter code of the language for messages: en, es or pt.

    Default: en-US

Responses

200

A page of your saved addresses.

  • totalintegerrequired

    Total number of matching records.

  • limitintegerrequired

    Page size used for this response.

  • skipintegerrequired

    Number of records skipped before this page.

  • dataarray of Account addressrequired
    The Account address object
401

Missing or invalid access token

  • namestring
    Always NotAuthenticated
  • messagestring
  • codenumber
    Always 401
  • classNamestring
    Always not-authenticated
  • dataobject
403

You do not have access to this account

  • namestring
    Always Forbidden
  • messagestring
  • codenumber
    Always 403
  • classNamestring
    Always forbidden
  • dataobject
GET/account-addresses
1
2
curl 'https://sandbox.weshipyou.com/api/v1/account-addresses' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "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"
    }
  ]
}
Try itSend a real request to Test from this page. No code needed.

Save an address

POST/account-addresses
Requires an access token

Adds a sender or recipient to the address book of one of your accounts (accountId).

Header parameters

  • Accept-Languagestring

    Two-letter code of the language for messages: en, es or pt.

    Default: en-US

Request bodyapplication/json

  • useExistingAddressboolean
  • nicknamestringnullable
  • addressobjectrequired
    Child attributes
    • cityobject
      Child attributes
      • namestringnullable
      • stateobject
        Child attributes
        • namestringnullable
    • streetstring

      Street address, including the building or apartment number.

    • postalCodestring
  • namestringrequirednullable
    at least 1 characters
  • companyNamestringnullable
  • taxIdstringnullable
  • taxIdCountryobject

    A country, by its ISO 3166-1 alpha-2 code.

    Child attributes
    • isoCodestring
      Allowed values:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
      exactly 2 characters
  • phonestring <phone>requirednullable
    at least 1 characters
  • emailstring <email>requirednullable

    Recipient email address

  • countryobjectrequired

    A country, by its ISO 3166-1 alpha-2 code.

    Child attributes
    • isoCodestring
      Allowed values:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
      exactly 2 characters
  • accountIdstringrequired

Responses

201

The saved address

The Account address object
400

Validation error; data holds the message for each invalid field

  • namestring
    Always BadRequest
  • messagestring
  • codenumber
    Always 400
  • classNamestring
    Always bad-request
  • dataobject
401

Missing or invalid access token

  • namestring
    Always NotAuthenticated
  • messagestring
  • codenumber
    Always 401
  • classNamestring
    Always not-authenticated
  • dataobject
403

You do not have access to this account

  • namestring
    Always Forbidden
  • messagestring
  • codenumber
    Always 403
  • classNamestring
    Always forbidden
  • dataobject
POST/account-addresses
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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"
}'
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "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"
}
Try itSend a real request to Test from this page. No code needed.

Update an address

PATCH/account-addresses/{accountAddressId}
Requires an access token

Changes the fields you send. While the address is used by a shipment that is in transit or delivered, its identity fields (name, phone, address, tax id, …) cannot change and the request answers 400; save a new address instead.

Path parameters

  • accountAddressIdstringrequired

    The address uid.

Header parameters

  • Accept-Languagestring

    Two-letter code of the language for messages: en, es or pt.

    Default: en-US

Request bodyapplication/json

  • useExistingAddressboolean
  • nicknamestringnullable
  • addressobjectrequired
    Child attributes
    • cityobject
      Child attributes
      • namestringnullable
      • stateobject
        Child attributes
        • namestringnullable
    • streetstring

      Street address, including the building or apartment number.

    • postalCodestring
  • namestringrequirednullable
    at least 1 characters
  • companyNamestringnullable
  • taxIdstringnullable
  • taxIdCountryobject

    A country, by its ISO 3166-1 alpha-2 code.

    Child attributes
    • isoCodestring
      Allowed values:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
      exactly 2 characters
  • phonestring <phone>requirednullable
    at least 1 characters
  • emailstring <email>requirednullable

    Recipient email address

  • countryobjectrequired

    A country, by its ISO 3166-1 alpha-2 code.

    Child attributes
    • isoCodestring
      Allowed values:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
      exactly 2 characters

Responses

200

The updated address

The Account address object
400

Validation error, or a locked field of an address in use

  • namestring
    Always BadRequest
  • messagestring
  • codenumber
    Always 400
  • classNamestring
    Always bad-request
  • dataobject
401

Missing or invalid access token

  • namestring
    Always NotAuthenticated
  • messagestring
  • codenumber
    Always 401
  • classNamestring
    Always not-authenticated
  • dataobject
403

You do not have access to this account

  • namestring
    Always Forbidden
  • messagestring
  • codenumber
    Always 403
  • classNamestring
    Always forbidden
  • dataobject
404

No shipment has that id

  • namestring
    Always NotFound
  • messagestring
  • codenumber
    Always 404
  • classNamestring
    Always not-found
  • dataobject
PATCH/account-addresses/{accountAddressId}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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"
  }
}'
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "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"
}
Try itSend a real request to Test from this page. No code needed.