Skip to main content

SchedulePickupInput

A pickup of returned goods.

input SchedulePickupInput {
  address: String
  delivery: ShipmentBookingInput
  instructions: String
  pickupDate: String
}

Fields​

SchedulePickupInput.address ● String scalar​

The address to collect from.

SchedulePickupInput.delivery ● ShipmentBookingInput input​

A courier to book for the pickup. Needs the sales:shipment:create permission and the deliveryPartners plan feature. Leave out to only record the pickup.

SchedulePickupInput.instructions ● String scalar​

Instructions for the pickup.

SchedulePickupInput.pickupDate ● String scalar​

The date of the pickup.

Member Of​

scheduleReturnPickup mutation