ShipmentCostSplit

Staff only (needs sales:sales_order:ship): what this shipment's courier charged at booking and how it was split between the customer (their billed shipping share) and the seller. Decimal strings in currency.

type ShipmentCostSplit {
  changedAt: DateTime
  changedByName: String
  courierCharge: String!
  currency: String!
  customerChose: ShipmentCostSplitCustomerChoice
  customerPaid: String!
  plannedCost: String
  policy: CourierCostPolicy
  reason: String
  sellerPaid: String!
  variance: String
}

Fields

ShipmentCostSplit.changedAt ● DateTime scalar

When the courier was changed.

ShipmentCostSplit.changedByName ● String scalar

Who changed the courier on the order.

ShipmentCostSplit.courierCharge ● String! non-null scalar

What the courier charged for the shipment at booking.

ShipmentCostSplit.currency ● String! non-null scalar

ISO 4217 currency code.

ShipmentCostSplit.customerChose ● ShipmentCostSplitCustomerChoice object

The customer's original choice.

ShipmentCostSplit.customerPaid ● String! non-null scalar

The part of the customer's shipping charge that falls on this shipment.

ShipmentCostSplit.plannedCost ● String scalar

The planned courier charge for the shipment when staff changed the courier. Empty without a plan.

ShipmentCostSplit.policy ● CourierCostPolicy enum

Who pays the difference under the order's courier plan. Empty without a plan.

ShipmentCostSplit.reason ● String scalar

Why the seller pays. Required when the seller's share is above zero.

ShipmentCostSplit.sellerPaid ● String! non-null scalar

The courier charge minus what the customer paid. Negative when the customer paid more than the courier charged.

ShipmentCostSplit.variance ● String scalar

The courier charge minus the planned cost. Negative when it was cheaper than planned. Empty without a plan.

Member Of

ShipmentGql object