Skip to main content

ordersReload

Reload orders from their source integration. The changes are applied directly, or proposed for review when the integration supports it.

Business Rules​

  • Only orders that have not yet completed fulfillment can be reloaded.
  • Reloading is asynchronous: the mutation enqueues the work and returns a process id to track progress.
  • Up to 50 orders can be reloaded per request.
  • When the integration supports review, the order does not change. A pending change proposal is created with the field and line changes the source reports. When the process finishes, its metadata lists them as change_proposals.
  • A new proposal replaces the pending proposal of the order, whoever asked for the reload.
  • When the source reports no changes, no proposal is created.

Error Scenarios​

  • **BAD_REQUEST**: when no order IDs are provided, or more than 50 are provided.
  • The process reports a failure for an order that is not in a refreshable status, or whose source integration is archived or does not support reloading.

Permissions Required​

  • orders:refresh_order permission
ordersReload(
  input: OrdersReloadInput!
): AsynchronousActionResponse

Arguments​

ordersReload.input ● OrdersReloadInput! non-null input common​

Parameters for OrdersReload

Type​

AsynchronousActionResponse object common​

Asynchronous action response type