Properties
Optional addressValidation
Optional advancedOptions
advanced
Options
?: { 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 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 eventNotification?: boolean
-
Optional fedexFreight?: {
bookingConfirmation?: string;
shipperLoadAndCount?: string;
}
-
Optional bookingConfirmation?: string
-
Optional shipperLoadAndCount?: string
-
Optional freightClass?: string
-
Optional limitedQuantity?: boolean
-
Optional nonMachinable?: boolean
-
-
Optional ownDocumentUpload?: boolean
-
Optional returnPickupAttempts?: number
-
Optional saturdayDelivery?: boolean
-
Optional shipperRelease?: boolean
-
Optional thirdPartyConsignee?: boolean
-
Optional useUpsGroundFreightPricing?: boolean
-
Optional assignedUser
assignedUser?: null | string
carrierId
carrierId: string
Optional comparisonRateType
comparisonRateType?: null | string
createdAt
createdAt: string
Optional externalOrderId
externalOrderId?: null | string
Optional externalShipmentId
externalShipmentId?: null | string
Optional holdUntilDate
holdUntilDate?: null | string
Optional isGift
isGift?: boolean
Optional isReturn
isReturn?: boolean
modifiedAt
modifiedAt: string
Optional notesForGift
notesForGift?: null | string
Optional notesFromBuyer
notesFromBuyer?: null | string
Optional requestedShipmentService
requestedShipmentService?: null | string
Optional retailRate
retailRate?: null | number
serviceCode
serviceCode: null | string
Optional shipByDate
shipByDate?: null | string
Optional shipDate
shipDate?: string
shipmentId
shipmentId: string
Optional shipmentNumber
shipmentNumber?: string
Optional shippingRuleId
shippingRuleId?: null | string
tags
tags: {
name: string;
}[]
Optional warehouseId
warehouseId?: null | string