Skip to main content

CartPostageData

Shipping and delivery configuration for the shopping cart.

Contains information about shipping methods, costs, delivery preferences, and pickup options for the cart.

type CartPostageData {
carrier: String
carrierData: Carrier
method: String!
taxPercentage: Int
requestDate: DateTime
price: Float
priceNet: Float
priceMode: PriceMode
partialDeliveryAllowed: YesNo
pickUpLocationId: Int
warehouse: Warehouse
}

Fields

CartPostageData.carrier ● String scalar

Selected shipping carrier identifier.

Code or name of the carrier responsible for delivering this order (e.g., 'DHL', 'UPS', 'FedEx').

CartPostageData.carrierData ● Carrier object

Retrieve the shipping carrier associated with this cart postage data.

Returns the carrier information including service details, coverage areas, and integration settings used. Used to display carrier-specific tracking information and branding.

CartPostageData.method ● String! non-null scalar

Selected shipping method for the cart.

Identifies the chosen delivery method such as 'DELIVERY', 'PICKUP', or specific carrier services.

CartPostageData.taxPercentage ● Int scalar

Tax rate percentage applied to shipping costs.

Percentage rate used to calculate tax on shipping and handling fees.

CartPostageData.requestDate ● DateTime scalar

Preferred delivery date requested by the customer.

Target date when the customer would like to receive their order. Used for delivery scheduling and planning.

CartPostageData.price ● Float scalar

Shipping cost excluding VAT.

Base shipping fee calculated based on the selected method, carrier rates, and applicable business rules.

CartPostageData.priceNet ● Float scalar

Shipping cost including VAT.

Total shipping fee including all applicable taxes and surcharges.

CartPostageData.priceMode ● PriceMode enum

Source of the shipping price calculation.

Indicates whether shipping costs were calculated using platform rules (PLATFORM) or provided by external systems (EXTERNAL).

CartPostageData.partialDeliveryAllowed ● YesNo enum

Whether partial deliveries are allowed for this order.

Indicates if the order can be split into multiple shipments when items have different availability or delivery dates.

CartPostageData.pickUpLocationId ● Int scalar

Identifier for the pickup location.

Used when the shipping method involves customer pickup from a designated location such as a store or pickup point.

CartPostageData.warehouse ● Warehouse object

Complete warehouse information for the pickup location.

Detailed warehouse object including address, business hours, and contact information for the customer pickup location.

Member Of

Cart object