Class ScanForm

Class representing an EasyPost scan form.

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

Properties

| Improve this Doc View Source

Address

The Address that packages will be shipped from.

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

BatchId

The ID of the Batch associated with this scan form.

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

FormFileType

The file format of the scan form document.

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

FormUrl

The URL of the scan form document.

Declaration
public string? FormUrl { 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 scan form's life cycle.

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

Status

The current status of the scan form. Valid statuses are:

  • "creating"
  • "created"
  • "failed"
Declaration
public string? Status { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

TrackingCodes

A list of tracking codes included in the scan form.

Declaration
public List<string>? TrackingCodes { get; set; }
Property Value
Type Description
System.Nullable<List<System.String>>

Implements