Skip to main content

CourierPlan

The order's courier plan: the customer's original choice and price, the active staff change (null after Use Customer's Choice) and the history. Staff only.

type CourierPlan {
  current: CourierPlanChange
  history: [CourierPlanEntry!]!
  lockReason: String
  original: CourierPlanOriginal!
  shareHold: CourierShareHoldReason
}

Fields​

CourierPlan.current ● CourierPlanChange object​

The active staff change. Null when the customer's choice applies.

CourierPlan.history ● [CourierPlanEntry!]! non-null object​

Every change and revert, oldest first, capped at the newest 50.

CourierPlan.lockReason ● String scalar​

Why the courier cannot be changed now (invoiced, shipped, cancelled, and so on). Null while a change is allowed.

CourierPlan.original ● CourierPlanOriginal! non-null object​

The customer's original courier choice and shipping price.

CourierPlan.shareHold ● CourierShareHoldReason enum​

Why a courier change made now would keep the customer's share at the order's current shipping: PAID or ONLINE_CHECKOUT; null when the share would move. For the order as it stands, with or without a current change.

Member Of​

SalesOrder object