SHshipstation
freight

Connect a freight provider account

Changed on
<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Connect a freight account the seller already holds with the provider. Both connectable providers — speedship (WWEX) and unishippers — authenticate with an OAuth client ID / secret pair issued by the provider.

The credentials are verified against the provider before they are stored, so a 201 means the connection can be quoted against immediately.

A seller may hold one connection per provider. Connecting a provider that is already connected returns 409 with error code freight_provider_already_connected and the existing freight_provider_account_id. Use PUT /v2/freight/provider_accounts/{freight_provider_account_id}/credentials to rotate credentials on the existing connection. Use DELETE /v2/freight/provider_accounts/{freight_provider_account_id} to disconnect it.

post/v2/freight/provider_accounts

Request

Request body

freight_provider_codestring required

The code of the provider to connect. The connectable codes are the freight_provider_code values returned by List freight provider accounts. Currently supported: speedship (WWEX) and unishippers.

client_idstring required

The OAuth client ID issued by the freight provider.

client_secretstring required

The OAuth client secret issued by the freight provider.

nicknamestring nullable

An optional label for the connection. Echoed back by List freight provider accounts.

Example request

{
  "freight_provider_code": "speedship",
  "client_id": "my-client-id",
  "client_secret": "my-client-secret",
  "nickname": "My WWEX account"
}

Response

The freight provider account was connected successfully.

freight_provider_account_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

freight_provider_codestring

The code of the freight provider, such as UNISHIPPERS or WWEX. This is the same value returned as freight_provider_code on quotes, shipments, and tracking.

nicknamestring nullable

The name given to the connection when it was set up, or null when it has none.

Example response

{
  "freight_provider_account_id": "se-28529731",
  "freight_provider_code": "UNISHIPPERS",
  "nickname": "Unishippers - Midwest"
}

Changes

  • ded10df771dbRevision changes
    • warning

      added the new funding_source_missing_configuration enum value to the // response property for the response status

    • warning

      added the new funding_source_missing_configuration enum value to the // response property for the response status

    • warning

      added the new funding_sources enum value to the // response property for the response status

    • warning

      added the new funding_sources enum value to the // response property for the response status

  • 4e29670aa28dRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status