Skip to main content
Log inSign up
mutation

Requires write_orders access scope. Also: This mutation is only accessible to apps authenticated using offline tokens.

Creates an order with attributes such as customer information, line items, and shipping and billing addresses.

Use the orderCreate mutation to programmatically generate orders in scenarios where orders aren't created through the standard checkout process, such as when importing orders from an external system or creating orders for wholesale customers.

The orderCreate mutation doesn't support applying multiple discounts, such as discounts on line items. Automatic discounts won't be applied unless you replicate the logic of those discounts in your custom implementation. You can apply a discount code, but only one discount code can be set for each order.


Note

If you're using the orderCreate mutation with a trial or development store, then you can create a maximum of five new orders per minute.


After you create an order, you can make subsequent edits to the order using one of the following mutations:

  • orderUpdate: Used for simple updates to an order, such as changing the order's note, tags, or customer information.
  • orderEditBegin: Used when you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts. The orderEditBegin mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the orderEditBegin mutation to edit existing orders.

Learn how to build apps that integrate with order management and fulfillment processes.

•

The strategies for updating inventory and whether to send shipping and order confirmations to customers.

•

The attributes of the new order.


Was this section helpful?

Anchor to OrderCreatePayload returnsOrderCreatePayload returns

•

The order that was created.

•

The list of errors that occurred from executing the mutation.


Was this section helpful?