import type { Address } from './Address'; import type { ShippingMethodReference } from './ShippingMethodReference'; /** * @type Shipment: Document representing a shipment. * * @property adjustedMerchandizeTotalTax: The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. * * @property adjustedShippingTotalTax: The total tax on shipping charges in the shipment, including shipping price adjustments. * * @property gift: A flag indicating whether the shipment is a gift. * * @property giftMessage: The gift message. * - **Max Length:** 4000 * * @property merchandizeTotalTax: The total tax on products in the shipment, not including price adjustments or service charges such as shipping. * * @property productSubTotal: The total price of all products in the shipment, including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn\'t include tax. If the taxation policy is gross, it includes tax. * * @property productTotal: The total price of all products in the shipment including item-level adjustments and prorated order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn\'t include tax. If the taxation policy is gross, it includes tax. * * @property shipmentId: The order-specific ID of the shipment. The default value is \'me\'. * - **Min Length:** 1 * - **Max Length:** 256 * * @property shipmentNo: The shipment number of this shipment. This number is automatically generated. * - **Max Length:** 256 * * @property shipmentTotal: The total price of all products in the shipment including item-level adjustments, shipping charges, and tax. * * @property shippingAddress: The shipping address. * * @property shippingMethod: The shipping method. * * @property shippingStatus: The shipping status of the shipment. * * @property shippingTotal: The total price of all shipping charges in the shipment, including shipping adjustments. If the taxation policy is net, it doesn\'t include tax. If the taxation policy is gross, it includes tax. * * @property shippingTotalTax: The total tax on shipping charges in the shipment, not including shipping price adjustments. * * @property taxTotal: The total tax on the shipment, including item-level price adjustments and service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. This field value must match the summed up taxTotal, and an InvalidTaxTotalException is thrown if the values do not match. * * @property trackingNumber: The tracking number of the shipment. * - **Max Length:** 256 * */ export type Shipment = { adjustedMerchandizeTotalTax?: number; adjustedShippingTotalTax?: number; gift?: boolean; giftMessage?: string; merchandizeTotalTax?: number; productSubTotal?: number; productTotal?: number; shipmentId: string; shipmentNo: string; shipmentTotal?: number; shippingAddress?: Address; shippingMethod?: ShippingMethodReference; shippingStatus?: ShipmentShippingStatusEnum; shippingTotal?: number; shippingTotalTax?: number; taxTotal?: number; trackingNumber?: string; } & { [key: string]: any; }; export type ShipmentShippingStatusEnum = 'not_shipped' | 'shipped';