Skip to content

Latest commit

 

History

History
349 lines (287 loc) · 12.3 KB

WarehousesApi.md

File metadata and controls

349 lines (287 loc) · 12.3 KB

Warehouses Methods

Method Description
CreateWarehouse Create Warehouse
DeleteWarehouse Delete Warehouse By ID
GetWarehouseById Get Warehouse By Id
ListWarehouses List Warehouses
UpdateWarehouse Update Warehouse By Id
UpdateWarehouseSettings Update Warehouse Settings

CreateWarehouse

CreateWarehouseResponseBody CreateWarehouse (CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default)

CreateWarehouseResponseBody CreateWarehouse (HttpClient methodClient, CreateWarehouseRequestBody createWarehouseRequestBody, CancellationToken cancellationToken = default)

Create Warehouse

Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well

Example

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

namespace Example
{
    public class CreateWarehouseExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createWarehouseRequestBody = new CreateWarehouseRequestBody();

            try
            {
                // Create Warehouse
                CreateWarehouseResponseBody result = await shipEngine.CreateWarehouse(createWarehouseRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.CreateWarehouse: " + 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.
createWarehouseRequestBody CreateWarehouseRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

CreateWarehouseResponseBody

DeleteWarehouse

string DeleteWarehouse (string warehouseId, CancellationToken cancellationToken = default)

string DeleteWarehouse (HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default)

Delete Warehouse By ID

Delete a warehouse by ID

Example

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

namespace Example
{
    public class DeleteWarehouseExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var warehouseId = "warehouseId_example";

            try
            {
                // Delete Warehouse By ID
                string result = await shipEngine.DeleteWarehouse(warehouseId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.DeleteWarehouse: " + 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.
warehouseId string Warehouse ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string

GetWarehouseById

GetWarehouseByIdResponseBody GetWarehouseById (string warehouseId, CancellationToken cancellationToken = default)

GetWarehouseByIdResponseBody GetWarehouseById (HttpClient methodClient, string warehouseId, CancellationToken cancellationToken = default)

Get Warehouse By Id

Retrieve warehouse data based on the warehouse ID

Example

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

namespace Example
{
    public class GetWarehouseByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var warehouseId = "warehouseId_example";

            try
            {
                // Get Warehouse By Id
                GetWarehouseByIdResponseBody result = await shipEngine.GetWarehouseById(warehouseId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.GetWarehouseById: " + 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.
warehouseId string Warehouse ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetWarehouseByIdResponseBody

ListWarehouses

ListWarehousesResponseBody ListWarehouses (CancellationToken cancellationToken = default)

ListWarehousesResponseBody ListWarehouses (HttpClient methodClient, CancellationToken cancellationToken = default)

List Warehouses

Retrieve a list of warehouses associated with this account.

Example

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

namespace Example
{
    public class ListWarehousesExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");

            try
            {
                // List Warehouses
                ListWarehousesResponseBody result = await shipEngine.ListWarehouses();
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.ListWarehouses: " + 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.
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

ListWarehousesResponseBody

UpdateWarehouse

string UpdateWarehouse (UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default)

string UpdateWarehouse (HttpClient methodClient, UpdateWarehouseRequestBody updateWarehouseRequestBody, string warehouseId, CancellationToken cancellationToken = default)

Update Warehouse By Id

Update Warehouse object information

Example

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

namespace Example
{
    public class UpdateWarehouseExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var updateWarehouseRequestBody = new UpdateWarehouseRequestBody();
            var warehouseId = "warehouseId_example";

            try
            {
                // Update Warehouse By Id
                string result = await shipEngine.UpdateWarehouse(updateWarehouseRequestBody, warehouseId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.UpdateWarehouse: " + 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.
updateWarehouseRequestBody UpdateWarehouseRequestBody
warehouseId string Warehouse ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string

UpdateWarehouseSettings

string UpdateWarehouseSettings (UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default)

string UpdateWarehouseSettings (HttpClient methodClient, UpdateWarehouseSettingsRequestBody updateWarehouseSettingsRequestBody, string warehouseId, CancellationToken cancellationToken = default)

Update Warehouse Settings

Update Warehouse settings object information

Example

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

namespace Example
{
    public class UpdateWarehouseSettingsExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var updateWarehouseSettingsRequestBody = new UpdateWarehouseSettingsRequestBody();
            var warehouseId = "warehouseId_example";

            try
            {
                // Update Warehouse Settings
                string result = await shipEngine.UpdateWarehouseSettings(updateWarehouseSettingsRequestBody, warehouseId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling WarehousesApi.UpdateWarehouseSettings: " + 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.
updateWarehouseSettingsRequestBody UpdateWarehouseSettingsRequestBody
warehouseId string Warehouse ID
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string