OrderShipment
This type represents an order shipment. An order can have multiple shipments, each one associated with a fulfillment and a carrier that shipped the order
type OrderShipment {
account: String
actualCarrierName: String
actualCarrierServiceName: String
carrier: Carrier @deprecated
carrierId: ID
carrierName: String
carrierService: String
carrierServiceId: ID @deprecated
cartons: Int
cost: Decimal
createdAt: ISO8601DateTime!
deliveredDate: ISO8601DateTime
expectedDeliveryDate: ISO8601DateTime
fulfillment: OrderFulfillment
fulfillmentId: ID
height: Decimal
id: ID!
length: Decimal
packageType: PackageTypeEnum!
pallets: Int
shippedDate: ISO8601DateTime!
shippingCarrierService: String
shippingContainers: [ShippingContainer!]
status: String!
trackingNumber: String
trackingUrl: Url
updatedAt: ISO8601DateTime!
weight: Decimal
width: Decimal
}
Fields
OrderShipment.account ● String scalar
OrderShipment.actualCarrierName ● String scalar
OrderShipment.actualCarrierServiceName ● String scalar
OrderShipment.carrier ● Carrier deprecated object
Outdated method for carriers
OrderShipment.carrierId ● ID scalar
OrderShipment.carrierName ● String scalar
The name of the carrier used for the order. This field returns the carrier
name in the last shipment. For a full list of carrier names used in the order,
use shipments field.
OrderShipment.carrierService ● String scalar
The carrier service used for the order. This field returns the carrier service
in the last shipment. For a full list of carrier services used in the order,
use shipments field.
OrderShipment.carrierServiceId ● ID deprecated scalar
Outdated method for carriers
OrderShipment.cartons ● Int scalar
The number of cartons in the shipment
OrderShipment.cost ● Decimal scalar
OrderShipment.createdAt ● ISO8601DateTime! non-null scalar
OrderShipment.deliveredDate ● ISO8601DateTime scalar
OrderShipment.expectedDeliveryDate ● ISO8601DateTime scalar
OrderShipment.fulfillment ● OrderFulfillment object
OrderShipment.fulfillmentId ● ID scalar
OrderShipment.height ● Decimal scalar
OrderShipment.id ● ID! non-null scalar
OrderShipment.length ● Decimal scalar
OrderShipment.packageType ● PackageTypeEnum! non-null enum
OrderShipment.pallets ● Int scalar
The number of pallets in the shipment
OrderShipment.shippedDate ● ISO8601DateTime! non-null scalar
OrderShipment.shippingCarrierService ● String scalar
OrderShipment.shippingContainers ● [ShippingContainer!] list object
The shipping containers associated with this shipment.
OrderShipment.status ● String! non-null scalar
OrderShipment.trackingNumber ● String scalar
OrderShipment.trackingUrl ● Url scalar
OrderShipment.updatedAt ● ISO8601DateTime! non-null scalar
OrderShipment.weight ● Decimal scalar
OrderShipment.width ● Decimal scalar
Member Of
OrderFulfillment object ● ShippingContainer object
Implemented By
OrderShipmentUnion union