Skip to main content

ChangeOrderCourierInput

Input to change the courier of a sales order.

input ChangeOrderCourierInput {
  carrierName: String!
  deliveryPartnerConfigId: ID!
  expectedVersion: Int
  idempotencyKey: String
  policy: CourierCostPolicy!
  reason: String
  salesOrderId: ID!
  serviceLevelCode: String!
}

Fields​

ChangeOrderCourierInput.carrierName ● String! non-null scalar​

The carrier of that rate (an aggregator can quote several carriers under one service).

ChangeOrderCourierInput.deliveryPartnerConfigId ● ID! non-null scalar​

The ID of the delivery partner of the live rate staff picked.

ChangeOrderCourierInput.expectedVersion ● Int scalar​

The order version you last read. The change is refused if the order has changed since.

ChangeOrderCourierInput.idempotencyKey ● String scalar​

A client-chosen key; repeating a request with the same key does not change the order twice.

ChangeOrderCourierInput.policy ● CourierCostPolicy! non-null enum​

Who bears the courier cost. Only KEEP_CUSTOMER_PRICE is accepted.

ChangeOrderCourierInput.reason ● String scalar​

Why the courier is changed. Required whenever the seller pays any part of the cost.

ChangeOrderCourierInput.salesOrderId ● ID! non-null scalar​

The ID of the sales order.

ChangeOrderCourierInput.serviceLevelCode ● String! non-null scalar​

The carrier's code for the service level.

Member Of​

changeOrderCourier mutation