Hierarchy

  • Shipment

Properties

addressValidation?: SE.AddressValidation
advancedOptions?: {
    additionalHandling?: boolean;
    ancillaryEndorsementsOption?: string;
    billToAccount?: string;
    billToCountryCode?: string;
    billToParty?: SE.BillToParties;
    billToPostalCode?: string;
    canadaDeliveredDuty?: null | "sender_prepay";
    collectOnDelivery?: {
        paymentAmount: SE.Money;
        paymentType: SE.PaymentTypes;
    };
    containsAlcohol?: boolean;
    customField1?: string;
    customField2?: string;
    customField3?: string;
    deliveredDutyPaid?: boolean;
    dryIce?: boolean;
    dryIceWeight?: SE.WeightWithUnit;
    eventNotification?: boolean;
    fedexFreight?: {
        bookingConfirmation?: string;
        shipperLoadAndCount?: string;
    };
    freightClass?: string;
    limitedQuantity?: boolean;
    nonMachinable?: boolean;
    originType?: SE.OriginTypes;
    ownDocumentUpload?: boolean;
    returnPickupAttempts?: number;
    saturdayDelivery?: boolean;
    shipperRelease?: boolean;
    thirdPartyConsignee?: boolean;
    useUpsGroundFreightPricing?: boolean;
    windsorFrameworkDetails?: SE.WindsorFrameworkDetails;
}

Type declaration

  • Optional additionalHandling?: boolean
  • Optional ancillaryEndorsementsOption?: string
  • Optional billToAccount?: string
  • Optional billToCountryCode?: string
  • Optional billToParty?: SE.BillToParties
  • Optional billToPostalCode?: string
  • Optional canadaDeliveredDuty?: null | "sender_prepay"
  • Optional collectOnDelivery?: {
        paymentAmount: SE.Money;
        paymentType: SE.PaymentTypes;
    }
  • Optional containsAlcohol?: boolean
  • Optional customField1?: string
  • Optional customField2?: string
  • Optional customField3?: string
  • Optional deliveredDutyPaid?: boolean
  • Optional dryIce?: boolean
  • Optional dryIceWeight?: SE.WeightWithUnit
  • Optional eventNotification?: boolean
  • Optional fedexFreight?: {
        bookingConfirmation?: string;
        shipperLoadAndCount?: string;
    }
    • Optional bookingConfirmation?: string
    • Optional shipperLoadAndCount?: string
  • Optional freightClass?: string
  • Optional limitedQuantity?: boolean
  • Optional nonMachinable?: boolean
  • Optional originType?: SE.OriginTypes
  • Optional ownDocumentUpload?: boolean
  • Optional returnPickupAttempts?: number
  • Optional saturdayDelivery?: boolean
  • Optional shipperRelease?: boolean
  • Optional thirdPartyConsignee?: boolean
  • Optional useUpsGroundFreightPricing?: boolean
  • Optional windsorFrameworkDetails?: SE.WindsorFrameworkDetails
carrierId: string
comparisonRateType?: string
confirmation: SE.ConfirmationType
createdAt: string
customs?: SE.Customs
externalOrderId?: string
externalShipmentId?: string
insuranceProvider: SE.InsuranceProviderType
isReturn?: boolean
items: SE.ShipmentItem[]
modifiedAt: string
orderSourceCode: null | SE.OrderSourceCode
originType?: SE.OriginTypes
packages: SE.ShipmentPackage[]
returnTo: null | SE.Address
serviceCode: null | string
shipDate?: string
shipFrom: null | SE.Address
shipTo: SE.Address
shipmentId: string
shipmentNumber?: string
shipmentStatus: SE.ShipmentStatus
shippingRuleId?: string
tags: {
    name: string;
}[]
taxIdentifiers?: SE.TaxIdentifier[]
totalWeight: SE.WeightWithUnit
validateAddress?: SE.AddressValidationOptions
warehouseId?: string

Generated using TypeDoc