Labels Methods

Method	Description
CreateCombinedLabelDocument	Created Combined Label Document
CreateLabel	Purchase Label
CreateLabelFromRate	Purchase Label with Rate ID
CreateLabelFromRateShopper	Purchase Label from Rate Shopper
CreateLabelFromShipment	Purchase Label with Shipment ID
CreateReturnLabel	Create a return label
GetLabelByExternalShipmentId	Get Label By External Shipment ID
GetLabelById	Get Label By ID
GetTrackingLogFromLabel	Get Label Tracking Information
ListLabels	List labels
VoidLabel	Void a Label By ID

CreateCombinedLabelDocument

CreateCombinedLabelDocumentResponseBodyYaml CreateCombinedLabelDocument (CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default)

CreateCombinedLabelDocumentResponseBodyYaml CreateCombinedLabelDocument (HttpClient methodClient, CreateCombinedLabelDocumentRequestBody createCombinedLabelDocumentRequestBody, CancellationToken cancellationToken = default)

Created Combined Label Document

Download a combined label file

Example

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

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

            try
            {
                // Created Combined Label Document
                CreateCombinedLabelDocumentResponseBodyYaml result = await shipEngine.CreateCombinedLabelDocument(createCombinedLabelDocumentRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateCombinedLabelDocument: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createCombinedLabelDocumentRequestBody	CreateCombinedLabelDocumentRequestBody
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateCombinedLabelDocumentResponseBodyYaml

CreateLabel

CreateLabelResponseBody CreateLabel (CreateLabelRequestBody createLabelRequestBody, CancellationToken cancellationToken = default)

CreateLabelResponseBody CreateLabel (HttpClient methodClient, CreateLabelRequestBody createLabelRequestBody, CancellationToken cancellationToken = default)

Purchase Label

Purchase and print a label for shipment

Example

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

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

            try
            {
                // Purchase Label
                CreateLabelResponseBody result = await shipEngine.CreateLabel(createLabelRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateLabel: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createLabelRequestBody	CreateLabelRequestBody
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateLabelResponseBody

CreateLabelFromRate

CreateLabelFromRateResponseBody CreateLabelFromRate (CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default)

CreateLabelFromRateResponseBody CreateLabelFromRate (HttpClient methodClient, CreateLabelFromRateRequestBody createLabelFromRateRequestBody, string rateId, CancellationToken cancellationToken = default)

Purchase Label with Rate ID

When retrieving rates for shipments using the /rates endpoint, the returned information contains a rate_id property that can be used to generate a label without having to refill in the shipment information repeatedly.

Example

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

namespace Example
{
    public class CreateLabelFromRateExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createLabelFromRateRequestBody = new CreateLabelFromRateRequestBody();
            var rateId = "rateId_example";

            try
            {
                // Purchase Label with Rate ID
                CreateLabelFromRateResponseBody result = await shipEngine.CreateLabelFromRate(createLabelFromRateRequestBody, rateId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateLabelFromRate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createLabelFromRateRequestBody	CreateLabelFromRateRequestBody
rateId	string	Rate ID
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateLabelFromRateResponseBody

CreateLabelFromRateShopper

CreateLabelRateShopperResponseBody CreateLabelFromRateShopper (CreateLabelRateShopperRequestBody createLabelRateShopperRequestBody, RateAttributes rateShopperId, CancellationToken cancellationToken = default)

CreateLabelRateShopperResponseBody CreateLabelFromRateShopper (HttpClient methodClient, CreateLabelRateShopperRequestBody createLabelRateShopperRequestBody, RateAttributes rateShopperId, CancellationToken cancellationToken = default)

Purchase Label from Rate Shopper

Purchase and print a shipping label using the Rate Shopper. The Rate Shopper automatically selects the optimal carrier and service from your wallet carriers based on your specified rate selection strategy (cheapest, fastest, or best_value). For more information about this in the rates documentation.

Example

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

namespace Example
{
    public class CreateLabelFromRateShopperExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createLabelRateShopperRequestBody = new CreateLabelRateShopperRequestBody();
            var rateShopperId = (RateAttributes) "best_value";

            try
            {
                // Purchase Label from Rate Shopper
                CreateLabelRateShopperResponseBody result = await shipEngine.CreateLabelFromRateShopper(createLabelRateShopperRequestBody, rateShopperId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateLabelFromRateShopper: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createLabelRateShopperRequestBody	CreateLabelRateShopperRequestBody	Label creation details with inline shipment
rateShopperId	RateAttributes	The rate selection strategy for the Rate Shopper. This determines which carrier and service will be automatically selected from your wallet carriers based on the rates returned for the shipment.
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateLabelRateShopperResponseBody

CreateLabelFromShipment

CreateLabelFromShipmentResponseBody CreateLabelFromShipment (CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default)

CreateLabelFromShipmentResponseBody CreateLabelFromShipment (HttpClient methodClient, CreateLabelFromShipmentRequestBody createLabelFromShipmentRequestBody, string shipmentId, CancellationToken cancellationToken = default)

Purchase Label with Shipment ID

Purchase a label using a shipment ID that has already been created with the desired address and package info.

Example

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

namespace Example
{
    public class CreateLabelFromShipmentExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createLabelFromShipmentRequestBody = new CreateLabelFromShipmentRequestBody();
            var shipmentId = "shipmentId_example";

            try
            {
                // Purchase Label with Shipment ID
                CreateLabelFromShipmentResponseBody result = await shipEngine.CreateLabelFromShipment(createLabelFromShipmentRequestBody, shipmentId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateLabelFromShipment: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createLabelFromShipmentRequestBody	CreateLabelFromShipmentRequestBody
shipmentId	string	Shipment ID
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateLabelFromShipmentResponseBody

CreateReturnLabel

CreateReturnLabelResponseBody CreateReturnLabel (CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default)

CreateReturnLabelResponseBody CreateReturnLabel (HttpClient methodClient, CreateReturnLabelRequestBody createReturnLabelRequestBody, string labelId, CancellationToken cancellationToken = default)

Create a return label

Create a return label for an existing outbound label. You can optionally specify a custom RMA (Return Merchandise Authorization) number. If no RMA number is provided, the system will auto-generate one.

Example

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

namespace Example
{
    public class CreateReturnLabelExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createReturnLabelRequestBody = new CreateReturnLabelRequestBody();
            var labelId = "labelId_example";

            try
            {
                // Create a return label
                CreateReturnLabelResponseBody result = await shipEngine.CreateReturnLabel(createReturnLabelRequestBody, labelId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.CreateReturnLabel: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
createReturnLabelRequestBody	CreateReturnLabelRequestBody
labelId	string	Label ID
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

CreateReturnLabelResponseBody

GetLabelByExternalShipmentId

GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (string externalShipmentId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default)

GetLabelByExternalShipmentIdResponseBody GetLabelByExternalShipmentId (HttpClient methodClient, string externalShipmentId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default)

Get Label By External Shipment ID

Find a label by using the external shipment id that was used during label creation

Example

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

namespace Example
{
    public class GetLabelByExternalShipmentIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var externalShipmentId = 0bcb569d-1727-4ff9-ab49-b2fec0cee5ae;
            var labelDownloadType = url;

            try
            {
                // Get Label By External Shipment ID
                GetLabelByExternalShipmentIdResponseBody result = await shipEngine.GetLabelByExternalShipmentId(externalShipmentId, labelDownloadType);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.GetLabelByExternalShipmentId: " + 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.
externalShipmentId	string
labelDownloadType	LabelDownloadType		[optional]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

GetLabelByExternalShipmentIdResponseBody

GetLabelById

GetLabelByIdResponseBody GetLabelById (string labelId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default)

GetLabelByIdResponseBody GetLabelById (HttpClient methodClient, string labelId, LabelDownloadType labelDownloadType = null, CancellationToken cancellationToken = default)

Get Label By ID

Retrieve information for individual labels.

Example

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

namespace Example
{
    public class GetLabelByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var labelId = "labelId_example";
            var labelDownloadType = url;

            try
            {
                // Get Label By ID
                GetLabelByIdResponseBody result = await shipEngine.GetLabelById(labelId, labelDownloadType);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.GetLabelById: " + 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.
labelId	string	Label ID
labelDownloadType	LabelDownloadType		[optional]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

GetLabelByIdResponseBody

GetTrackingLogFromLabel

GetTrackingLogFromLabelResponseBody GetTrackingLogFromLabel (string labelId, CancellationToken cancellationToken = default)

GetTrackingLogFromLabelResponseBody GetTrackingLogFromLabel (HttpClient methodClient, string labelId, CancellationToken cancellationToken = default)

Get Label Tracking Information

Retrieve the label's tracking information

Example

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

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

            try
            {
                // Get Label Tracking Information
                GetTrackingLogFromLabelResponseBody result = await shipEngine.GetTrackingLogFromLabel(labelId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.GetTrackingLogFromLabel: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
labelId	string	Label ID
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

GetTrackingLogFromLabelResponseBody

ListLabels

ListLabelsResponseBody ListLabels (DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, LabelStatus labelStatus = null, SortDir sortDir = null, string serviceCode = null, string carrierId = null, string trackingNumber = null, string batchId = null, string rateId = null, string shipmentId = null, string warehouseId = null, int page = null, int pageSize = null, string sortBy = null, CancellationToken cancellationToken = default)

ListLabelsResponseBody ListLabels (HttpClient methodClient, DateTimeOffset createdAtStart = null, DateTimeOffset createdAtEnd = null, LabelStatus labelStatus = null, SortDir sortDir = null, string serviceCode = null, string carrierId = null, string trackingNumber = null, string batchId = null, string rateId = null, string shipmentId = null, string warehouseId = null, int page = null, int pageSize = null, string sortBy = null, CancellationToken cancellationToken = default)

List labels

This endpoint returns a list of labels that you've created. You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both warehouse_id and carrier_id

Example

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

namespace Example
{
    public class ListLabelsExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createdAtStart = 2019-03-12T19:24:13.657Z;
            var createdAtEnd = 2019-03-12T19:24:13.657Z;
            var labelStatus = (LabelStatus) "processing";
            var sortDir = (SortDir) "asc";
            var serviceCode = usps_first_class_mail;
            var carrierId = "carrierId_example";
            var trackingNumber = 9405511899223197428490;
            var batchId = "batchId_example";
            var rateId = "rateId_example";
            var shipmentId = "shipmentId_example";
            var warehouseId = "warehouseId_example";
            var page = 2;
            var pageSize = 50;
            var sortBy = "modified_at";

            try
            {
                // List labels
                ListLabelsResponseBody result = await shipEngine.ListLabels(createdAtStart, createdAtEnd, labelStatus, sortDir, serviceCode, carrierId, trackingNumber, batchId, rateId, shipmentId, warehouseId, page, pageSize, sortBy);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.ListLabels: " + 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.
createdAtStart	DateTimeOffset	Only return labels that were created on or after a specific date/time	[optional]
createdAtEnd	DateTimeOffset	Only return labels that were created on or before a specific date/time	[optional]
labelStatus	LabelStatus	Only return labels that are currently in the specified status	[optional]
sortDir	SortDir	Controls the sort order of the query.	[optional]
serviceCode	string	Only return labels for a specific carrier service	[optional]
carrierId	string	Only return labels for a specific carrier account	[optional]
trackingNumber	string	Only return labels with a specific tracking number	[optional]
batchId	string	Only return labels that were created in a specific batch	[optional]
rateId	string	Rate ID	[optional]
shipmentId	string	Shipment ID	[optional]
warehouseId	string	Only return labels that originate from a specific warehouse	[optional]
page	int	Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.	[optional] [default to 1]
pageSize	int	The number of results to return per response.	[optional] [default to 25]
sortBy	string	Controls which field the query is sorted by.	[optional] [default to created_at]
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

ListLabelsResponseBody

VoidLabel

VoidLabelResponseBody VoidLabel (string labelId, CancellationToken cancellationToken = default)

VoidLabelResponseBody VoidLabel (HttpClient methodClient, string labelId, CancellationToken cancellationToken = default)

Void a Label By ID

Void a label by ID to get a refund.

Example

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

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

            try
            {
                // Void a Label By ID
                VoidLabelResponseBody result = await shipEngine.VoidLabel(labelId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling LabelsApi.VoidLabel: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
methodClient	HttpClient	The HttpClient instance to use for the request.
labelId	string	Label ID
cancellationToken	CancellationToken	The cancellation token to use for the request.

Return type

VoidLabelResponseBody

FilesExpand file tree

LabelsApi.md

Latest commit

History

LabelsApi.md

File metadata and controls

Labels Methods

CreateCombinedLabelDocument

Example

Parameters

Return type

CreateLabel

Example

Parameters

Return type

CreateLabelFromRate

Example

Parameters

Return type

CreateLabelFromRateShopper

Example

Parameters

Return type

CreateLabelFromShipment

Example

Parameters

Return type

CreateReturnLabel

Example

Parameters

Return type

GetLabelByExternalShipmentId

Example

Parameters

Return type

GetLabelById

Example

Parameters

Return type

GetTrackingLogFromLabel

Example

Parameters

Return type

ListLabels

Example

Parameters

Return type

VoidLabel

Example

Parameters

Return type