carrier_accounts

Connect a carrier account

Changed on

Connect a carrier account

post/v1/connections/carriers/{carrier_name}

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/connections/carriers/{carrier_name}
  • Auth: API key in header API-Key

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "nickname": "Stamps.com"
}

Response

The request was a success.

carrier_idstring required

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

Example response

{
  "carrier_id": "se-28529731"
}

Changes

  • e998dffc42beRevision 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 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 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

    • warning

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

  • 83d18f07d1b8Revision changes
    • breaking

      removed from the request body anyOf list

    • info

      added to the request body anyOf list