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
  • Transactions
  • Add Funds
  • Add Sub Account
    • The Sub-account object
    • POSTAdd a 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
  • Transactions
  • Add Funds
  • Add Sub Account
    • The Sub-account object
    • POSTAdd a sub-account
Download the OpenAPI spec

Add Sub Account

Create sub-accounts

  • POST/add-sub-account

The Sub-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 Sub-account object
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      {
  "name": "Contract Branch",
  "displayName": "Contract Branch",
  "systemUnits": "imperial",
  "email": "jane.doe@example.com",
  "notificationEmail": "jane.doe@example.com",
  "website": "https://example.com",
  "phone": "+13055550100",
  "emergencyPhone": "+13055550101",
  "uid": "85js5f5clt2u",
  "accountNumber": "CUDHMFEDA9",
  "parentUid": "h4jupn7wtfqp",
  "status": "active",
  "language": "en",
  "isBusiness": true,
  "createdAt": "2026-11-01T00:37:55.618Z",
  "updatedAt": "2026-11-01T00:37:55.618Z",
  "revision": 1
}

      Add a sub-account

      POST/add-sub-account
      Requires an access token

      Creates a sub-account under one of your accounts (accountUid), with its own forwarding address. The answer names the parent in parentUid; list the sub-accounts later with GET /accounts?parentUid=.

      Header parameters

      • Accept-Languagestring

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

        Default: en-US

      Request bodyapplication/json

      The sub-account to create.

      • accountUidstring

        The uid of the parent account, one you belong to. Optional when you belong to a single account (the sub-account is created under it).

      • externalAccountNumberstring
      • 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.

          Responses

          201

          Successful operation

          The Sub-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

          accountUid is not one of your accounts, or that account may not hold sub-accounts

          • namestring
            Always Forbidden
          • messagestring
          • codenumber
            Always 403
          • classNamestring
            Always forbidden
          • dataobject
          POST/add-sub-account
          1
          2
          3
          4
          5
          6
          7
          8
          9
          10
          11
          12
          13
          14
          15
          16
          17
          18
          19
          20
          21
          curl -X POST 'https://sandbox.weshipyou.com/api/v1/add-sub-account' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "accountUid": "h4jupn7wtfqp",
  "externalAccountNumber": "STORE-7",
  "name": "Jane'\''s Store Orlando",
  "displayName": "Jane'\''s Store Orlando",
  "systemUnits": "imperial",
  "email": "orlando@janesstore.com",
  "notificationEmail": "orlando-orders@janesstore.com",
  "website": "https://janesstore.com",
  "phone": "+1 (786) 651-0451",
  "emergencyPhone": "+1 (786) 651-0452",
  "taxId": "88-1345985",
  "taxIdCountry": {
    "isoCode": "US"
  },
  "language": "en-US",
  "isBusiness": true
}'
          Response
          1
          2
          3
          4
          5
          6
          7
          8
          9
          10
          11
          12
          13
          14
          15
          16
          17
          18
          19
          {
  "name": "Contract Branch",
  "displayName": "Contract Branch",
  "systemUnits": "imperial",
  "email": "jane.doe@example.com",
  "notificationEmail": "jane.doe@example.com",
  "website": "https://example.com",
  "phone": "+13055550100",
  "emergencyPhone": "+13055550101",
  "uid": "85js5f5clt2u",
  "accountNumber": "CUDHMFEDA9",
  "parentUid": "h4jupn7wtfqp",
  "status": "active",
  "language": "en",
  "isBusiness": true,
  "createdAt": "2026-11-01T00:37:55.618Z",
  "updatedAt": "2026-11-01T00:37:55.618Z",
  "revision": 1
}
          Try itSend a real request to Test from this page. No code needed.