Skip to main content

orderCreateFromCheckout Mutation

Create new order from existing checkout.

Requires the following permissions: AUTHENTICATED_APPHANDLE_CHECKOUTS

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
  • ORDER_CREATED (async): Triggered when order is created.
  • NOTIFY_USER (async): A notification for order placement.
  • NOTIFY_USER (async): A staff notification for order placement.
  • ORDER_UPDATED (async): Triggered when order received the update after placement.
  • ORDER_PAID (async): Triggered when newly created order is paid.
  • ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.
  • ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.
orderCreateFromCheckout(
  id: ID!
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  removeCheckout: Boolean = true
): OrderCreateFromCheckout

Arguments​

orderCreateFromCheckout.id ● ID! non-null scalar miscellaneous​

ID of a checkout that will be converted to an order.

orderCreateFromCheckout.metadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the checkout metadata.

orderCreateFromCheckout.privateMetadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the checkout private metadata.

orderCreateFromCheckout.removeCheckout ● Boolean scalar miscellaneous​

Determines if checkout should be removed after creating an order. Default true.

Type​

OrderCreateFromCheckout object orders​

Create new order from existing checkout.

Requires the following permissions: AUTHENTICATED_APPHANDLE_CHECKOUTS

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
  • ORDER_CREATED (async): Triggered when order is created.
  • NOTIFY_USER (async): A notification for order placement.
  • NOTIFY_USER (async): A staff notification for order placement.
  • ORDER_UPDATED (async): Triggered when order received the update after placement.
  • ORDER_PAID (async): Triggered when newly created order is paid.
  • ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.
  • ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.