Module @shipgenius/oms/models

Interfaces and classes describing the input and output types for the API

All output types are described by a class, while input types are an interface.

Output types are also given interfaces, but these are meant mostly for internal use.

Enumerations

CarrierErrorCode

The type of issue encountered in request to a carrier

CarrierName

The name of a carrier, used when requesting rates

ChargeType

The type of reason a for a charge

ClassOneCompatibilityGroup

The compatibility group for Class 1 Hazardous Materials as described in 49 CFR 173.52

DayCountMethod

Which days count for determining the number of ship days

FedexPickupType

How FedEx will pick up the package

HazmatDivision

The class and division of the hazmat

HazmatPackagingForm

How the hazmat is packaged

HazmatPackingGroup

A packing group specifying how dangerous the hazmat is

LabelFormat

The formats a label image can be returned in

LengthUnit

A unit of length measurement

LithiumBatteryCondition

What condition the lithium battery is in

LithiumBatteryContainment

How the lithium battery is packaged

LithiumBatteryType

The type of lithium battery

Locale

A language/dialect code.

MessageSeverity

The severity of a message/warning

RateAndShipPriority

The metric to prioritize when selecting a service

RateClass

The pricing class of rates to return

RelationToShipment

The subscriber's relation to the shipping of the package

ShippingRegionType

Where a service can ship from and to

ShippingTimeGuaranteeLevel

A service's confidence of their delivery date

StateCode

A two-letter US state code

TrackingNotificationLevel

The types of events that will trigger notifications

TrackingStatusCode

The type of tracking event

UpsPackagingType

The hazmat container type for UPS

UpsTransportationMode

The allowed transportation mode for UPS

UspsDestinationEntryFacilityType

The types of USPS destinations entry facilities

UspsProcessingCategory

The processing category for USPS

UspsTrackingPlusOption

Options for USPS Tracking Plus

VoidLabelResponse

The result of attempting to void a label

WeightUnit

A unit of weight measurement

Classes

AdditionalAddressInformation

Additional information about the address, mostly concerning its validity

Address

An address returned by the API

AddressValidationError

Information about why an address validation failed to run

AddressValidationInfo

Informatin about a successful address validation

AddressValidationNote

A note or warning about the address validation

AddressValidationResponse

Base class for objects returned by address validation

BulkDomesticLabelResponse

A batch of generated labels

BulkDomesticRateResponse

Rate information returned for a rated package

Carrier

A mail carrier

CarrierList

A list of carriers

CarrierService

A supported shipping service

CarrierServiceList

A list of carrier services

CarrierWarning

A warning issued by a carrier

DateInformation

Different representations of a date

DatetimeInformation

Different representations

DeliverySchedule

Information about the expected delivery times for the shipment

DeliveryWindow

The window of time during which the delivery is expected

DomesticAddress

A domestic US address returned by the API

DomesticLabel

A created shipping label.

DomesticLabelError

An error occurring

DomesticLabelResponse

Interface version of DomesticLabelResponse

DomesticRate

Interface version of DomesticRate

DomesticRateError

Interface version of DomesticRateError

DomesticRateResponse

Base class for returned rates

ItemizedCharge

A line item on a list of itemized charges

LabelData

An image of the label

LabelImage

An image of the label

TrackingAddress

An address relevant to the tracking of a shipment

TrackingAddressAndContact

Interface version of TrackingAddressAndContact

TrackingContactInfo

A contact at an address relevant to the tracking of a shipment

TrackingDeliveryInformation

Information about the delivery of a package

TrackingEvent

An event in the shipment's tracking history

TrackingInformation

Information about the shipping status and history of a package

TrackingShipment

Information the shipment itself

TrackingStatus

The details of a shipment's status

Interfaces

AdditionalAddressInformationInterface

Interface version of AdditionalAddressInformation

AdditionalDomesticInfoInput

Additional information about shipments

AddressInput

Base interface for addresses entered into the API

AddressInterface

Interface version of Address

AddressValidationErrorInterface

Interface version of AddressValidationError

AddressValidationInfoInterface

Interface version of AddressValidationInfo

AddressValidationNoteInterface

Interface version of AddressValidationNote

AddressValidationResponseInterface

Interface version of AddressValidationResponse

ArbitraryMeasurement

A measurement with arbitrary units

BagDimensions

A custom bag (soft or polybag) used for packaging

BoxDimensions

A custom rigid corrugated box used for packaging

BulkDomesticLabelResponseInterface

Interface version of BulkDomesticLabelResponse

BulkDomesticRateResponseInterface

Interface version of BulkDomesticRateResponse

CarbonNeutral

Attempt to ship the package in a carbon-neutral way

CarrierDependentExtraServiceOption

Carrier services that apply to multiple carriers, but may be ignored by some carriers

CarrierDependentOrderInfo

A JSON object value, with undefined allowed because it gets stripped by JSON.parse

CarrierInterface

Interface version of Carrier

CarrierListInterface

Interface version of CarrierList

CarrierRelease

Permission for the carrier to release a package without signature

CarrierServiceInterface

Interface version of CarrierService

CarrierServiceLabelInput

The service to use to ship the package.

CarrierServiceListInterface

Interface version of CarrierServiceList

CarrierServiceRateInput

A specification of a carrier service to rate with

CarrierSpecificDryIceInfo

Information specific carriers need for dry ice

CarrierSpecificExtraServiceOption

Carrier services that apply to a specific carrier.

CarrierSpecificOrderInfo

Extra requests and information only specific carriers support

CarrierSpecificOtherHazmatInformation

Information only specific carriers need for fully-regulated hazmat

CarrierSpecificPackaging

A carrier specific packaging code is used instead of a custom bag or box

CarrierSpecificShipmentInsurance

Carrier-specific information needed for insuring a package

CarrierSpecificSignatureMail

Carrier-specific information about signing for a package

CarrierWarningInterface

Interface version of CarrierWarning

DateFields

The fields of a date

DatetimeFields

The fields of a datetime

DeliverByDate

Expect the package to be delivered by a certain date

DeliverInDays

Expect the package to arrive within a certain number of days

DeliveryScheduleInterface

Interface version of DeliverySchedule

DeliveryWindowInterface

Interface version of DeliveryWindow

DisallowForwarding

Request the shipment not be forwarded if the recipient has a new address.

DomesticAddressInput

A US domestic address, as entered as input to the API

DomesticAddressInterface

Interface version of DomesticAddress

DomesticLabelErrorInterface

Interface version of DomesticLabelError

DomesticLabelInterface

Interface version of DomesticLabel

DomesticLabelResponseInterface

Interface version of DomesticLabelResponse

DomesticPackageLabelInput

Information about the package being shipped

DomesticPackageRateInput

Description of a package to be rated

DomesticRateAndShipInput

Information needed to run rate-and-ship

DomesticRateAndShipService

Information needed to specify a service for rate-and-ship

DomesticRateAndShipServiceSpecs

A list of carrier services and rules for how to select the best rate

DomesticRateErrorInterface

Interface version of DomesticRateError

DomesticRateInput

Information about a shipment to be rated

DomesticRateInterface

Interface version of DomesticRate

DomesticRateResponseInterface

Interface version of DomesticRateResponse

ExtraServiceOption

A request for an extra service.

FedExLabelInput

Extra information for printing FedEx labels

FedexSpecificSignatureMail

FedEx-specific information about signing for a packages

FullContactInformation

FullDomesticAddressInput with required email and phone number

FullDomesticAddressInput

Information about a domestic address and contact

FullShipmentIdentifier

Shipment identifier including carrier and account

GenericExtraService

A base class for other extra services

GenericHazmat

Base class for hazmat information

HazmatDryIce

Information needed to ship a package containing dry ice

HazmatExceptedQuantity

Hazardous materials in quantities low enough to be classified as Excepted Quantity.

HazmatInfo

Information needed to ship hazardous materials

HazmatLimitedQuantity

Hazardous materials in quantities low enough to be classified as Limited Quantity.

HazmatLithiumBattery

Information needed to ship a package containing lithium batteries

HazmatMagnet

Magnets that can deflect a compass from 7 feet must be marked as hazmat for air shipments.

HazmatOption

A hazardous material

HazmatOther

Hazardous materials that are not classified as any other option.

HazmatSmallQuantity

Hazardous materials in quantities low enough to be classified as Small Quantity

ItemizedChargeInterface

Interface version of ItemizedCharge

LabelBatchServiceInput

The service to ship the bulk shipment with by default

LabelCarrierInput

Extra carrier-specific information for rating and/or creating shipments

LabelCreationInput

Information needed to specify a shipment to be made

LabelDataInterface

Interface version of LabelData

LabelImageInterface

Interface version of LabelImage

LengthInput

A length with units

OrderInfo

Extra information and requests for the shipment

PartiallySupportedTrackingSubscriptionOptions

Additional options that may be ignored depending on which carrier the request is sent to.

RateAndShipFilters

Filters to remove certain rates from consideration.

ReferenceNumber

A reference number connecting a shipment to an external id

SaturdayDelivery

Request Saturday delivery, if available.

SaturdayPickup

Request pickup on a Saturday, if available.

ShipmentIdentifierOption

An ID for the shipment

ShipmentInsurance

A request to insure a package

ShippingTimeFilterOption

A requirement that a package arrive by a certain date

SignatureMail

A request that a package must be signed for

SundayDelivery

Request Sunday delivery, if available.

TrackingAddressAndContactInterface

Interface version of TrackingAddressAndContact

TrackingAddressInterface

Interface version of TrackingAddress

TrackingContactInfoInterface

Interface version of TrackingContactInfo

TrackingDeliveryInformationInterface

Interface version of TrackingDeliveryInformation

TrackingEventInterface

Interface version of TrackingEvent

TrackingInformationInterface

Interface version of TrackingInformation

TrackingRecipient

Where to send tracking information to.

TrackingShipmentInterface

Interface version of TrackingShipment

TrackingStatusInterface

Interface vetrsion of TrackingStatus

Trackingsubscription

Information needed to subscribe to tracking events

UpsSpecificDryIceInfo

Information UPS needs for dry ice shipments

UpsSpecificOtherHazmatInformation

Information only UPS needs for hazmat

UspsDestinationEntryFacility

Information about the USPS destination entry facility

UspsLabelInput

Extra information for printing USPS labels

UspsRegisteredMail

A request for USPS Registered Mail

UspsReturnReceipt

A request for USPS Return Receipt

UspsSpecificExtraServiceOption

A USPS-specific extra service

UspsSpecificOrderInfo

Extra requests and information only USPS supports

UspsSpecificShipmentInsurance

Information required by USPS for insuring a package

UspsSpecificSignatureMail

USPS-specific information about signing for a package

UspsTrackingPlus

A request for USPS Tracking Plus

WeightInput

A length with units

Type Aliases

CarrierDependentExtraService

Carrier services that apply to multiple carriers, but may be ignored by some carriers

CarrierSpecificExtraService

Carrier services that apply to a specific carrier.

ExtraService

A request for an extra service.

Hazmat

A hazardous material

Packaging

The type and dimensions of the packaging used.

PackagingOption

The type and dimensions of the packaging used.

ShipmentIdentifier

An ID for the shipment

ShippingTimeFilter

A requirement that a package arrive by a certain date

UspsSpecificExtraService

A USPS-specific extra service