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
    • The Account object
    • GETList your accounts
    • GETGet an account
    • PATCHUpdate an account
  • Account Addresses
  • 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
    • The Account object
    • GETList your accounts
    • GETGet an account
    • PATCHUpdate an account
  • Account Addresses
  • Transactions
  • Add Funds
  • Add Sub Account
Download the OpenAPI spec

Accounts

Your accounts

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

The Account object

Attributes

  • namestringrequired
    at least 1 characters
  • displayNamestringrequired
    at least 1 characters
  • systemUnitsstringrequired
    Allowed values:imperialmetric
  • emailstringrequired
    at least 1 characters
  • notificationEmailstringrequired
    at least 1 characters
  • websitestringrequirednullable
  • phonestringrequirednullable
    at least 1 characters
  • emergencyPhonestringrequirednullable
    at least 1 characters
  • taxIdstringnullable
  • taxIdCountryobjectnullable
    Child attributes
    • isoCodestringrequired
  • uidstringread-only
  • accountNumberstringread-only
  • parentUidstringnullableread-only

    The uid of the parent account when this is a sub-account, null otherwise.

  • statusstringread-only
  • languagestringrequired
  • isBusinessboolean | integerrequired
  • allowBankAccountPaymentsboolean | integerread-only
  • metadataobjectnullableread-only
  • createdAtstring <date-time>read-only
  • updatedAtstring <date-time>read-only
  • deletedAtstring <date-time>nullableread-only
  • addressIdnumbernullableread-only
  • billingAddressIdnumbernullableread-only
  • defaultShipFromIdnumbernullableread-only
  • defaultAddressOnLabelIdnumbernullableread-only
  • defaultReturnAddressIdnumbernullableread-only
  • primaryPaymentShipmentsIdnumbernullableread-only
  • logoIdnumbernullableread-only
  • pickupServiceFallbackIdnumbernullableread-only
  • revisionnumbernullableread-only
  • addressAccount address | object

    Main address of the account.

    Child attributes
      One of
      • 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 object
      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
      {
  "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
}

      List your accounts

      GET/accounts
      Requires an access token

      Lists the accounts you belong to and their sub-accounts. Each account names its parent in parentUid (null on an account you belong to directly), so ?parentUid= lists the sub-accounts of one account.

      Query parameters

      • $limitnumber

        Maximum number of results (default 20).

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

        Number of results to skip, for paging.

        Default: 0
        >= 0
      • parentUidstring

        Only the sub-accounts of this account: its uid, its account number (CU…) or its external account number. An account you cannot access returns an empty list.

      Header parameters

      • Accept-Languagestring

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

        Default: en-US

      Responses

      200

      A page of accounts

      • totalnumber
      • limitnumber
      • skipnumber
      • dataarray of Account
        The Account object
      401

      Missing or invalid access token

      • namestring
        Always NotAuthenticated
      • messagestring
      • codenumber
        Always 401
      • classNamestring
        Always not-authenticated
      • dataobject
      GET/accounts
      1
      2
      curl 'https://sandbox.weshipyou.com/api/v1/accounts?parentUid=h4jupn7wtfqp' \
  -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
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      {
  "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
    }
  ]
}
      Try itSend a real request to Test from this page. No code needed.

      Get an account

      GET/accounts/{accountId}
      Requires an access token

      Path parameters

      • accountIdstringrequired

        Account uid, account number (CU…) or external account number, of an account you belong to or one of its sub-accounts.

      Header parameters

      • Accept-Languagestring

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

        Default: en-US

      Responses

      200

      The account

      The Account object
      401

      Missing or invalid access token

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

      No shipment has that id

      • namestring
        Always NotFound
      • messagestring
      • codenumber
        Always 404
      • classNamestring
        Always not-found
      • dataobject
      GET/accounts/{accountId}
      1
      2
      curl 'https://sandbox.weshipyou.com/api/v1/accounts/{accountId}' \
  -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
      24
      25
      26
      27
      28
      {
  "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
}
      Try itSend a real request to Test from this page. No code needed.

      Update an account

      PATCH/accounts/{accountId}
      Requires an access token

      Changes the profile fields you send (name, contact details, language, units).

      Path parameters

      • accountIdstringrequired

        Account uid, account number (CU…) or external account number, of an account you belong to or one of its sub-accounts.

      Header parameters

      • Accept-Languagestring

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

        Default: en-US

      Request bodyapplication/json

      • namestring
        at least 1 characters
      • displayNamestring
        at least 1 characters
      • systemUnitsstring
        Allowed values:imperialmetric
      • emailstring
        at least 1 characters
      • notificationEmailstring
        at least 1 characters
      • websitestring
      • phonestring
        at least 1 characters
      • emergencyPhonestring
        at least 1 characters
      • taxIdstring
      • taxIdCountryobjectnullable
        Child attributes
        • isoCodestringrequired
      • languagestring
      • isBusinessboolean
      • addressobject
        Child attributes
        • 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 account

      The Account object
      400

      Invalid request

      • 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/accounts/{accountId}
      1
      2
      3
      4
      5
      6
      7
      8
      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"
}'
      Response
      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
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      {
  "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
}
      Try itSend a real request to Test from this page. No code needed.