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
    • The Access token object
    • POSTGet an access token
General
  • Shipments
  • Tracking
  • Services
Forwarder
  • Forwarder
Mobile Recharges
  • Mobile Recharges
Account
  • Accounts
  • Account Addresses
  • Transactions
  • Add Funds
  • Add Sub Account
Download the OpenAPI spec
Menu
  • Overview
Authentication process
  • Authentication
    • The Access token object
    • POSTGet an access token
General
  • Shipments
  • Tracking
  • Services
Forwarder
  • Forwarder
Mobile Recharges
  • Mobile Recharges
Account
  • Accounts
  • Account Addresses
  • Transactions
  • Add Funds
  • Add Sub Account
Download the OpenAPI spec

Authentication

Get an access token

  • POST/authentication

The Access token object

Attributes

  • accessTokenstring
  • iatnumber
  • expnumber
  • userobject
    Child attributes
    • idnumber
    • uidstring
    • usernamestring
    • emailstring
    • isEnabledboolean | integer
    • isVerifiedboolean | integer
    • invalidTokensBeforeAtstring <date-time>nullable
    • metadataobjectnullable
    • termsAgreementDatestring <date-time>nullable
    • termsAgreementVersionstringnullable
    • createdAtstring <date-time>
    • updatedAtstring <date-time>
    • deletedAtstring <date-time>nullable
    • roleIdnumber
    • avatarIdnumbernullable
    • revisionnumbernullable
    • roleobject
    • avatarobject
    • user_detailobject
      Child attributes
      • idnumbernullable
      • uidstringnullable
      • taxIdstringnullable
      • phonestringnullable
      • firstNamestringnullable
      • lastNamestringnullable
      • displayNamestringnullable
      • genderstringnullable
      • languagestringnullable
      • birthdaystring <date-time>nullable
      • createdAtstring <date-time>nullable
      • updatedAtstring <date-time>nullable
      • deletedAtstring <date-time>nullable
      • userIdnumbernullable
    • accountsarray of Account
      at least 1 items · at most 100 items
      Child 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
            • 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 Access token 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
      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
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
      {
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJzdWIiOiJjeGZ0b2N2bTJsY2ciLCJhdWQiOiJodHRwczovL3dlc2hpcHlvdS5jb20ifQ.SIGNATURE",
  "iat": 1793493470,
  "exp": 1825029470,
  "user": {
    "id": 1,
    "uid": "cxftocvm2lcg",
    "username": "janedoe",
    "email": "jane.doe@example.com",
    "isEnabled": 1,
    "isVerified": 1,
    "invalidTokensBeforeAt": null,
    "metadata": null,
    "termsAgreementDate": null,
    "termsAgreementVersion": null,
    "createdAt": "2026-11-01T00:37:50.000Z",
    "updatedAt": "2026-11-01T00:37:50.000Z",
    "deletedAt": null,
    "roleId": 1,
    "avatarId": null,
    "revision": null,
    "role": {
      "id": 1,
      "name": "customer",
      "inheritPermissionsFromRoleId": null,
      "inheritPermissionsFromRole": {
        "id": null,
        "name": null
      }
    },
    "avatar": {
      "id": null,
      "uid": null,
      "md5": null,
      "height": null,
      "width": null,
      "format": null,
      "awsUrl": null
    },
    "user_detail": {
      "id": null,
      "uid": null,
      "taxId": null,
      "phone": null,
      "firstName": null,
      "lastName": null,
      "displayName": null,
      "gender": null,
      "language": null,
      "birthday": null,
      "createdAt": null,
      "updatedAt": null,
      "deletedAt": null,
      "userId": null
    },
    "accounts": [
      {
        "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": "l96f0r4g37om",
        "accountNumber": "0000ACC1X1",
        "status": "active",
        "language": "en",
        "isBusiness": 0,
        "allowBankAccountPayments": 0,
        "metadata": null,
        "createdAt": "2026-11-01T00:37:50.000Z",
        "updatedAt": "2026-11-01T00:37:50.000Z",
        "deletedAt": null,
        "addressId": null,
        "billingAddressId": null,
        "defaultShipFromId": null,
        "defaultAddressOnLabelId": null,
        "defaultReturnAddressId": null,
        "primaryPaymentShipmentsId": null,
        "logoId": null,
        "pickupServiceFallbackId": null,
        "revision": null,
        "address": null
      }
    ]
  }
}

      Get an access token

      POST/authentication
      No access token needed

      Exchanges your username and password (plus the two-factor code when it is on) for a JWT access token. Send it as Authorization: Bearer <accessToken> on every other request.

      Header parameters

      • Accept-Languagestring

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

        Default: en-US

      Request bodyapplication/json

      Your WeShipYou login.

      • usernamestringrequired

        Your WeShipYou username or email.

        Default: {{username}}
      • passwordstringrequired

        Your password.

        Default: {{password}}
      • twoFactorTokenstring

        The current 6-digit code from your authenticator app. Required when two-factor authentication is on for your user.

        matches ^[0-9]{6}$
      • modestring

        test on the production server: you log in with your production username and password, and the answer is a Sandbox token. The sandbox gets a test copy of your user, your accounts and your memberships (no balance, payment methods or verification data), refreshed on every test login. Every token carries a livemode claim: true for production, false for the sandbox.

        Allowed values:livetest
        Default: live

      Responses

      201

      Logged in

      The Access token object
      400

      Invalid request

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

      Wrong username or password; Two-factor authentication required (with data.twoFactorRequired: true) when the code is missing; Invalid two-factor code when it is wrong.

      • namestring
        Always NotAuthenticated
      • messagestring
      • codenumber
        Always 401
      • classNamestring
        Always not-authenticated
      • dataobject
        Child attributes
        • twoFactorRequiredboolean
      409

      mode: "test" only: the sandbox already has a different user with your username or email.

      • namestring
        Always Conflict
      • messagestring
      • codenumber
        Always 409
      • classNamestring
        Always conflict
      503

      mode: "test" only: the sandbox could not be reached or could not open the test session. Your production login is not affected; try again in a minute.

      • namestring
        Always Unavailable
      • messagestring
      • codenumber
        Always 503
      • classNamestring
        Always unavailable
      POST/authentication
      1
      2
      3
      4
      5
      6
      7
      curl -X POST 'https://sandbox.weshipyou.com/api/v1/authentication' \
  -H "Content-Type: application/json" \
  -d '{
  "username": "janedoe",
  "password": "correct-horse-battery-staple",
  "twoFactorToken": "123456"
}'
      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
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
      {
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJzdWIiOiJjeGZ0b2N2bTJsY2ciLCJhdWQiOiJodHRwczovL3dlc2hpcHlvdS5jb20ifQ.SIGNATURE",
  "iat": 1793493470,
  "exp": 1825029470,
  "user": {
    "id": 1,
    "uid": "cxftocvm2lcg",
    "username": "janedoe",
    "email": "jane.doe@example.com",
    "isEnabled": 1,
    "isVerified": 1,
    "invalidTokensBeforeAt": null,
    "metadata": null,
    "termsAgreementDate": null,
    "termsAgreementVersion": null,
    "createdAt": "2026-11-01T00:37:50.000Z",
    "updatedAt": "2026-11-01T00:37:50.000Z",
    "deletedAt": null,
    "roleId": 1,
    "avatarId": null,
    "revision": null,
    "role": {
      "id": 1,
      "name": "customer",
      "inheritPermissionsFromRoleId": null,
      "inheritPermissionsFromRole": {
        "id": null,
        "name": null
      }
    },
    "avatar": {
      "id": null,
      "uid": null,
      "md5": null,
      "height": null,
      "width": null,
      "format": null,
      "awsUrl": null
    },
    "user_detail": {
      "id": null,
      "uid": null,
      "taxId": null,
      "phone": null,
      "firstName": null,
      "lastName": null,
      "displayName": null,
      "gender": null,
      "language": null,
      "birthday": null,
      "createdAt": null,
      "updatedAt": null,
      "deletedAt": null,
      "userId": null
    },
    "accounts": [
      {
        "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": "l96f0r4g37om",
        "accountNumber": "0000ACC1X1",
        "status": "active",
        "language": "en",
        "isBusiness": 0,
        "allowBankAccountPayments": 0,
        "metadata": null,
        "createdAt": "2026-11-01T00:37:50.000Z",
        "updatedAt": "2026-11-01T00:37:50.000Z",
        "deletedAt": null,
        "addressId": null,
        "billingAddressId": null,
        "defaultShipFromId": null,
        "defaultAddressOnLabelId": null,
        "defaultReturnAddressId": null,
        "primaryPaymentShipmentsId": null,
        "logoId": null,
        "pickupServiceFallbackId": null,
        "revision": null,
        "address": null
      }
    ]
  }
}
      Try itSend a real request to Test from this page. No code needed.