Skip to content

Latest commit

 

History

History
243 lines (201 loc) · 9.16 KB

CarrierAccountsApi.md

File metadata and controls

243 lines (201 loc) · 9.16 KB

CarrierAccounts Methods

Method Description
ConnectCarrier Connect a carrier account
DisconnectCarrier Disconnect a carrier
GetCarrierSettings Get carrier settings
UpdateCarrierSettings Update carrier settings

ConnectCarrier

ConnectCarrierResponseBody ConnectCarrier (CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)

ConnectCarrierResponseBody ConnectCarrier (HttpClient methodClient, CarrierName carrierName, ConnectCarrierRequestBody connectCarrierRequestBody, CancellationToken cancellationToken = default)

Connect a carrier account

Connect a carrier account

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class ConnectCarrierExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierName = dhl_express;
            var connectCarrierRequestBody = new ConnectCarrierRequestBody();

            try
            {
                // Connect a carrier account
                ConnectCarrierResponseBody result = await shipEngine.ConnectCarrier(carrierName, connectCarrierRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling CarrierAccountsApi.ConnectCarrier: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
carrierName CarrierName The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
connectCarrierRequestBody ConnectCarrierRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

ConnectCarrierResponseBody

DisconnectCarrier

string DisconnectCarrier (CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)

string DisconnectCarrier (HttpClient methodClient, CarrierName carrierName, string carrierId, CancellationToken cancellationToken = default)

Disconnect a carrier

Disconnect a carrier

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class DisconnectCarrierExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierName = dhl_express;
            var carrierId = se-28529731;

            try
            {
                // Disconnect a carrier
                string result = await shipEngine.DisconnectCarrier(carrierName, carrierId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling CarrierAccountsApi.DisconnectCarrier: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
carrierName CarrierName The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
carrierId string Carrier ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string

GetCarrierSettings

GetCarrierSettingsResponseBody GetCarrierSettings (CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)

GetCarrierSettingsResponseBody GetCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, string carrierId, CancellationToken cancellationToken = default)

Get carrier settings

Get carrier settings

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class GetCarrierSettingsExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierName = dhl_express;
            var carrierId = se-28529731;

            try
            {
                // Get carrier settings
                GetCarrierSettingsResponseBody result = await shipEngine.GetCarrierSettings(carrierName, carrierId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling CarrierAccountsApi.GetCarrierSettings: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
carrierName CarrierNameWithSettings The carrier name, such as `ups`, `fedex`, or `dhl_express`.
carrierId string Carrier ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetCarrierSettingsResponseBody

UpdateCarrierSettings

string UpdateCarrierSettings (CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)

string UpdateCarrierSettings (HttpClient methodClient, CarrierNameWithSettings carrierName, UpdateCarrierSettingsRequestBody updateCarrierSettingsRequestBody, string carrierId, CancellationToken cancellationToken = default)

Update carrier settings

Update carrier settings

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class UpdateCarrierSettingsExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var carrierName = dhl_express;
            var updateCarrierSettingsRequestBody = new UpdateCarrierSettingsRequestBody();
            var carrierId = se-28529731;

            try
            {
                // Update carrier settings
                string result = await shipEngine.UpdateCarrierSettings(carrierName, updateCarrierSettingsRequestBody, carrierId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling CarrierAccountsApi.UpdateCarrierSettings: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
carrierName CarrierNameWithSettings The carrier name, such as `ups`, `fedex`, or `dhl_express`.
updateCarrierSettingsRequestBody UpdateCarrierSettingsRequestBody
carrierId string Carrier ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string