Skip to main content

ShipmentsSummaryMoney

One currency's courier money on the shipments summary. Amounts are decimal strings, and currencies are never added together.

type ShipmentsSummaryMoney {
courierCharges: String!
currency: String!
customerPaid: String!
owedCount: Int!
owedToCouriers: String!
paidCount: Int!
paidToCouriers: String!
recoveryPercent: Float
sellerPaid: String!
shipmentCount: Int!
}

Fields​

ShipmentsSummaryMoney.courierCharges ● String! non-null scalar​

What the couriers charged.

ShipmentsSummaryMoney.currency ● String! non-null scalar​

ISO 4217 currency code.

ShipmentsSummaryMoney.customerPaid ● String! non-null scalar​

What the customers paid towards those charges.

ShipmentsSummaryMoney.owedCount ● Int! non-null scalar​

How many shipments are still owed to the courier.

ShipmentsSummaryMoney.owedToCouriers ● String! non-null scalar​

Courier charges not yet marked paid.

How many shipments the courier has been paid for.

Courier charges marked paid.

ShipmentsSummaryMoney.recoveryPercent ● Float scalar​

What the customers paid as a percent of the courier charges, to one decimal. Empty when the charges are zero.

ShipmentsSummaryMoney.sellerPaid ● String! non-null scalar​

What the seller absorbed: courier charges minus what the customers paid.

ShipmentsSummaryMoney.shipmentCount ● Int! non-null scalar​

How many shipments with a recorded cost split are in this currency.

Member Of​

ShipmentsSummary object