Class All

Parameters for API calls.

Inheritance
System.Object
BaseParameters<Shipment>
BaseAllParameters<Shipment>
All
Implements
Inherited Members
Namespace: EasyPost.Parameters.Shipment
Assembly: EasyPost.dll
Syntax
public class All : BaseAllParameters<Shipment>, IBaseParameters

Properties

| Improve this Doc View Source

AfterId

Only records created after the given ID will be included. May not be used with BeforeId.

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

BeforeId

Only records created before the given ID will be included. May not be used with AfterId.

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

EndDatetime

Only return records created before this timestamp. Defaults to 1 month ago, or 1 month before a passed StartDatetime.

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

IncludeChildren

If true, also include shipments created by child users.

Declaration
public bool? IncludeChildren { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

PageSize

The number of records to return on each page. The maximum value is 100, and default is 20.

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

Purchased

If true, only return purchased shipments. Defaults to true.

Declaration
public bool? Purchased { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

StartDatetime

Only return records created after this timestamp. Defaults to 1 month ago, or 1 month before a passed EndDatetime.

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

Methods

| Improve this Doc View Source

FromDictionary(Nullable<Dictionary<String, Object>>)

Convert a dictionary into this parameter set.

Declaration
public static All FromDictionary(Dictionary<string, object>? dictionary)
Parameters
Type Name Description
System.Nullable<Dictionary<System.String, System.Object>> dictionary

Dictionary to parse.
Returns
Type Description
All

An All parameters set.

Implements