Class Batch

Class representing an EasyPost batch.

Inheritance
System.Object
EphemeralEasyPostObject
EasyPostObject
Batch
Implements
Inherited Members
Namespace: EasyPost.Models.API
Assembly: EasyPost.dll
Syntax
public class Batch : EasyPostObject, IEasyPostObject, IBatchParameter, IParameter

Properties

| Improve this Doc View Source

Error

Potential error encountered while processing the batch.

Declaration
public string? Error { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

LabelUrl

The URL of the label image.

Declaration
public string? LabelUrl { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Message

A human-readable message for any errors that occurred during the batch's life cycle.

Declaration
public string? Message { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

NumShipments

The number of shipments in the batch.

Declaration
public int? NumShipments { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

Reference

An optional field that may be used in place of ID in some API endpoints.

Declaration
public string? Reference { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ScanForm

The ScanForm associated with the batch.

Declaration
public ScanForm ScanForm { get; set; }
Property Value
Type Description
ScanForm
| Improve this Doc View Source

Shipments

The BatchShipments associated with the batch.

Declaration
public List<BatchShipment>? Shipments { get; set; }
Property Value
Type Description
System.Nullable<List<BatchShipment>>
| Improve this Doc View Source

State

The current state of the batch. Possible values include: "creating", "creation_failed", "created", "purchasing", "purchase_failed", "purchased", "label_generating" and "label_generated".

Declaration
public string? State { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Status

A dictionary of BatchShipment statuses and their counts. Valid statuses are:

  • "postage_purchased"
  • "postage_purchase_failed"
  • "queued_for_purchase"
  • "creation_failed"
Declaration
public Dictionary<string, int>? Status { get; set; }
Property Value
Type Description
System.Nullable<Dictionary<System.String, System.Int32>>

Implements