connections

Get carrier settings

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 access__plan--off">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 access__plan--off">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan access__plan--off">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>

Get carrier settings

get/v2/connections/carriers/{carrier_name}/{carrier_id}/settings

Request

  • Base URL
    https://api.shipstation.com
  • URL
    https://api.shipstation.com/v2/connections/carriers/{carrier_name}/{carrier_id}/settings
  • Auth
    API key in header api-key

Response

The request was a success.

OR
OR

Example response

{
  "nickname": "My Carrier Account"
}

Changes

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

  • 934f5935dbeaRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to string for status

    • breaking

      the /// response's property type changed from no type to string for status

    • breaking

      the /// response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status