OBJECT

OrderMutation

Mutations that act on Orders.

link GraphQL Schema definition

  • type OrderMutation {
  • # Creates a new Order with tasks.
  • #
  • # Arguments
  • # order: The details for the order to create
  • # orderTasks: The details for the order to create
  • create(order: OrderCreate!, orderTasks: [OrderOrderTaskCreate]): SuccessResult
  • # Create a presigned url that users can upload order attachments directly from
  • # client side.
  • #
  • # Arguments
  • # filename: The name of the order attachment to create a
  • # presigned url for
  • createSignedUrl(filename: String!): SignedUrl
  • # Archives an order.
  • #
  • # Arguments
  • # id: The ID of the order to archive.
  • archive(id: Int!): SuccessResult
  • # Update the status of an existing order.
  • #
  • # Arguments
  • # id: The id of the order that the status needs to be updated
  • # for.
  • # status: The status of the order that the status needs to be
  • # updated for.
  • updateOrderStatus(id: Int!, status: OrderStatusTypes!): updateOrderStatusResult
  • # Merges an Order with its merge template.
  • #
  • # Arguments
  • # id: The ID of the order to merge.
  • summaryPDF(id: Int!): MergeResult
  • # Update an existing order.
  • #
  • # Arguments
  • # order: The details for the order to update
  • # orderTasks: The details for the order to update
  • # moveAllocations: If moveAllocations is set to true and the
  • # updated order has moved (different startDate), then all allocations for the
  • # order will be moved by the same number of days.
  • update(
  • order: OrderUpdate!,
  • orderTasks: [OrderTaskUpdate],
  • moveAllocations: Boolean
  • ): SuccessResult
  • # Update an order by passing start and end date which will resolve moving,
  • # shortening or extending the order, order tasks and allocations.
  • #
  • # Arguments
  • # id: The ID of the order.
  • # start_date: The start date of the order.
  • # end_date: The end date of the order.
  • # move_allocations: If move_allocations is set to true and the
  • # updated order has moved, then all allocations for the order will be moved by the
  • # same number of days
  • updateOrderByDates(
  • id: Int!,
  • start_date: DateExpression!,
  • end_date: DateExpression!,
  • move_allocations: Boolean
  • ): SuccessResult
  • # Duplicates the given order. Includes shifts and optionally allocations.
  • #
  • # Arguments
  • # id: The id of the order that is to be duplicated.
  • # duplicate_allocations: If true, allocations will also be
  • # duplicated to the order's tasks.
  • duplicate(id: Int!, duplicate_allocations: Boolean): DuplicateOrderResult
  • }