Skip to main content

CourierPlanChange

One staff change of the courier: the new service, its charge, who pays what, why, who and when. Staff only.

type CourierPlanChange {
  changedAt: DateTime!
  changedById: String!
  changedByName: String
  currency: String!
  customerShare: String!
  customerShareHeldBecausePaid: Boolean!
  heldReason: CourierShareHoldReason
  plannedCost: String!
  policy: CourierCostPolicy!
  reason: String
  sellerShare: String!
  service: PlannedCourierService!
}

Fields

`CourierPlanChange.changedAt` ● `DateTime!` non-null scalar

When the change was made.

`CourierPlanChange.changedById` ● `String!` non-null scalar

The ID of the user who made the change.

`CourierPlanChange.changedByName` ● `String` scalar

Display name of the user who made the change.

`CourierPlanChange.currency` ● `String!` non-null scalar

ISO 4217 currency code.

The amount billed to the customer for shipping, as a decimal string.

True when the order was already paid, or its online amount was fixed, so the customer's share stayed unchanged.

`CourierPlanChange.heldReason` ● `CourierShareHoldReason` enum

Why the customer's share was held. Null when it was not.

`CourierPlanChange.plannedCost` ● `String!` non-null scalar

The courier charge priced by the server when the change was made, as a decimal string.

`CourierPlanChange.policy` ● `CourierCostPolicy!` non-null enum

Who bears the courier cost.

`CourierPlanChange.reason` ● `String` scalar

Why staff made the change. Null when no reason was given.

The part of the courier charge the seller absorbs (planned cost minus customer share, never below 0), as a decimal string.

`CourierPlanChange.service` ● `PlannedCourierService!` non-null object

The courier service the order was changed to.

Member Of

CourierPlan object ● CourierPlanEntry object

Fields
Member Of