Developers

Developers

Quick Summary: Explore the Floship API, test in the sandbox, and learn how to request credentials.

Overview

The Developers page provides API reference material and sandbox testing access. It can also request credentials when the page offers Get Access.

Note: If Developers is missing, ask your company administrator to review your access.

Prerequisites

  • Your account must include Developers access.
  • Use sandbox credentials for testing before you connect to production.

Quick start

  1. Open the profile menu in the top right.
  2. Select Developers.
  3. Select Explore to open the API reference.
  4. Select Get Access if the page offers it.
  5. In production, use Production Token with its displayed URL when available.

Detailed guide

API resources

The page lists the main resource groups. Select Explore to see endpoints, parameters, and response formats in a new tab.

Resource group Common use
Authentication Identify your client account and authorize requests
Orders Create, retrieve, and update orders
Products Maintain product data
ASN's Manage inbound shipment notices
Shipping Options Review and select shipping services
Couriers Work with courier services
Countries Retrieve supported country data

API credentials

Send an API token with the Authorization: Token YOUR_TOKEN request header. Tokens identify your client account. Use each token only in its matching sandbox or production environment.

Production

In the production portal, Developers displays Production Token and its matching URL when a token has been issued. The sandbox portal does not display the production token.

Use the token only with its matching production URL. If no production token is available, contact your Account Manager through your secure account channel.

To replace an issued production token, select Regenerate Token under Production Token and confirm.

Warning: When regeneration succeeds, the previous production token stops working. Update every integration that uses it. Keep tokens out of logs, screenshots, and source control.

Sandbox

The sandbox lets you test requests without changing live data. Credentials appear only after they are provisioned.

Manage sandbox credentials from Developers in the production portal. If the controls are absent, contact your Account Manager.

Item Use
Sandbox Token Authorize API calls to the sandbox
Sandbox account Sign in to the sandbox portal
Regenerate Token Replace the sandbox API token
Regenerate Credentials Replace the sandbox account password

Select Regenerate Token only when the sandbox token needs replacement. Update your integration with the new token.

If the sandbox account shows Password is not set, select Regenerate Credentials. Store the new password securely.

Common workflows

Workflow: set up a new integration

  1. Open the profile menu and select Developers.
  2. Select Explore and choose the endpoints you need.
  3. Select Get Access when the page offers it.
  4. Open the sandbox URL with the displayed account details.
  5. Configure the sandbox URL and token in your integration.
  6. Test create and retrieve requests with sandbox data.
  7. In production, configure your integration with the displayed Production Token and its matching URL when available.

The integration can be tested in the sandbox before production credentials are issued. If no production token is available, request one through your secure account channel with your Account Manager.

Workflow: regenerate a compromised token

  1. Open Developers in the production portal.
  2. Find the Production Token or Sandbox Token section.
  3. Select Regenerate Token in that section and confirm.
  4. Update every integration that uses the replaced token.
  5. For a sandbox password, select Regenerate Credentials under Sandbox account.
  6. If the production token is unavailable, contact your Account Manager through your secure account channel.

Successful regeneration invalidates the previous token. Store the replacement securely.

Workflow: access API documentation

  1. Select Developers from the profile menu.
  2. Select Explore.
  3. Find the resource, endpoint, and request example you need.

Explore opens the API reference in a new tab.

Troubleshooting

Issue Cause Solution
Developers is missing The page or access is not enabled for the account Ask your company administrator to review access, or contact your Account Manager
No production token appears A token has not been issued, or the page is open in sandbox Check Production Token in production when available. Otherwise, contact your Account Manager through your secure account channel.
API calls return 401 Unauthorized The token is invalid, replaced, or from the other environment Use the current token with its matching environment URL. If no production token is available, contact your Account Manager securely.
Sandbox password is not set The sandbox account password has not been provisioned Select Regenerate Credentials and store the new password securely
Sandbox data is missing in production Sandbox and production use separate environments Recreate the setup in production after credentials are issued

Related Articles