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.

Applied directives

@webhookEventsInfo(asyncEvents: [ORDER_CREATED, NOTIFY_USER, NOTIFY_USER, ORDER_UPDATED, ORDER_PAID, ORDER_FULLY_PAID, ORDER_CONFIRMED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS, CHECKOUT_CALCULATE_TAXES])

orderCreateFromCheckout(id: ID!, metadata: [MetadataInput!], privateMetadata: [MetadataInput!], removeCheckout: Boolean = true): OrderCreateFromCheckout

Returns

OrderCreateFromCheckout

Show return type

type OrderCreateFromCheckout {
  order: Order
  errors: [OrderCreateFromCheckoutError!]!
}

Arguments

id

id · ID!

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

metadata

metadata · [MetadataInput!]

Fields required to update the checkout metadata. Can be read by any API client authorized to read the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata

privateMetadata · [MetadataInput!]

Fields required to update the checkout private metadata. Requires permissions to modify and to read the metadata of the object it’s attached to.

Warning: never store sensitive information, including financial data such as credit card details.

removeCheckout

removeCheckout · Boolean

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

Default: true.

Schema: Saleor 3.23.43. Download SDL.