Skip to main content

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 common

OrderShipment.actualCarrierName ● String scalar common

OrderShipment.actualCarrierServiceName ● String scalar common

OrderShipment.carrier ● Carrier deprecated object shipments

DEPRECATED

Outdated method for carriers

OrderShipment.carrierId ● ID scalar common

OrderShipment.carrierName ● String scalar common

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 common

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 common

DEPRECATED

Outdated method for carriers

OrderShipment.cartons ● Int scalar common

The number of cartons in the shipment

OrderShipment.cost ● Decimal scalar common

OrderShipment.createdAt ● ISO8601DateTime! non-null scalar common

OrderShipment.deliveredDate ● ISO8601DateTime scalar common

OrderShipment.expectedDeliveryDate ● ISO8601DateTime scalar common

OrderShipment.fulfillment ● OrderFulfillment object orders

OrderShipment.fulfillmentId ● ID scalar common

OrderShipment.height ● Decimal scalar common

OrderShipment.id ● ID! non-null scalar common

OrderShipment.length ● Decimal scalar common

OrderShipment.packageType ● PackageTypeEnum! non-null enum orders

OrderShipment.pallets ● Int scalar common

The number of pallets in the shipment

OrderShipment.shippedDate ● ISO8601DateTime! non-null scalar common

OrderShipment.shippingCarrierService ● String scalar common

OrderShipment.shippingContainers ● [ShippingContainer!] list object shipments

The shipping containers associated with this shipment.

OrderShipment.status ● String! non-null scalar common

OrderShipment.trackingNumber ● String scalar common

OrderShipment.trackingUrl ● Url scalar common

OrderShipment.updatedAt ● ISO8601DateTime! non-null scalar common

OrderShipment.weight ● Decimal scalar common

OrderShipment.width ● Decimal scalar common

Member Of

OrderFulfillment object ● ShippingContainer object

Implemented By

OrderShipmentUnion union