Skip to main content

DeliveryAppointmentOptions

What can be booked for a shipment at its warehouse, read live from the scheduling system.

type DeliveryAppointmentOptions {
  blockingFields: [String!]
  defaultCarrierName: String
  defaultContainerNumber: String
  defaultPalletCount: Int
  defaultReferenceNumber: String
  defaultVendorName: String
  fields: [DeliveryAppointmentField!]
  loadTypes: [DeliveryAppointmentLoadType!]!
  slots: [DeliveryAppointmentSlot!]
  warehouse: DeliveryAppointmentWarehouse
  warehouseMapped: Boolean!
  warehouseOrderMismatch: String
}

Fields​

DeliveryAppointmentOptions.blockingFields ● [String!] list scalar common​

Labels of required fields Endless cannot fill. When any are listed, book the appointment in the scheduling system instead. Null unless loadTypeId is given.

DeliveryAppointmentOptions.defaultCarrierName ● String scalar common​

The carrier name on the shipment, offered as the appointment's carrier.

DeliveryAppointmentOptions.defaultContainerNumber ● String scalar common​

The shipment's container number, offered for warehouse fields with the CONTAINER_NUMBER role. Null when the shipment has none.

DeliveryAppointmentOptions.defaultPalletCount ● Int scalar common​

The shipment's reported pallet count, offered as the appointment's pallet count. Null when the shipment has none reported; cartons are not counted.

DeliveryAppointmentOptions.defaultReferenceNumber ● String scalar common​

The shipment's ASN reference, used when no reference number is sent.

DeliveryAppointmentOptions.defaultVendorName ● String scalar common​

The company's name, offered for warehouse fields with the VENDOR_NAME role.

DeliveryAppointmentOptions.fields ● [DeliveryAppointmentField!] list object common​

The fields the warehouse asks for. Null unless loadTypeId is given.

DeliveryAppointmentOptions.loadTypes ● [DeliveryAppointmentLoadType!]! non-null object common​

The load types carriers can book at the warehouse.

DeliveryAppointmentOptions.slots ● [DeliveryAppointmentSlot!] list object common​

Open start times on the requested date. Null unless loadTypeId and date are given.

DeliveryAppointmentOptions.warehouse ● DeliveryAppointmentWarehouse object common​

The warehouse the appointment is booked at. Null when booking is blocked.

DeliveryAppointmentOptions.warehouseMapped ● Boolean! non-null scalar common​

Whether the shipment's destination warehouse is linked to a location in the scheduling integration. When false, every other field is empty: map the warehouse first.

DeliveryAppointmentOptions.warehouseOrderMismatch ● String scalar common​

Set when the warehouse system reports that the shipment's ASN is at a different warehouse than its destination. When set, every other field is empty: fix the order in the warehouse system first.

Returned By​

supplyDeliveryAppointmentOptions query