input_object
The input fields for creating an order.
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
Whether the customer consented to receive email updates from the shop.
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
The ID of the purchasing company's location for the order.
The shop-facing currency for the order. If not specified, then the shop's default currency is used.
A list of extra information that's added to the order. Appears in the Additional details section of an order details page.
The customer to associate to the order.
A discount code applied to the order.
A new customer email address for the order.
The financial status of the order. If not specified, then this will be derived through the given transactions. Note that it's possible to specify a status that doesn't match the given transactions and it will persist, but if an operation later occurs on the order, the status may then be recalculated to match the current state of transactions.
The fulfillment to create for the order. This will apply to all line items.
The fulfillment status of the order. Will default to
unfulfilledif not included.The line items to create for the order.
A list of metafields to add to the order.
The order name, generated by combining the
property with the order prefix and suffix that are set in the merchant's general settings. This is different from theidproperty, which is the ID of the order used by the API. This field can also be set by the API to be any string value.The new contents for the note associated with the order.
A new customer phone number for the order.
The purchase order number associated to this order.
The presentment currency that was used to display prices to the customer. This must be specified if any presentment currencies are used in the order.
The date and time (ISO 8601 format) when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports. If you're importing orders from an app or another platform, then you can set processed_at to a date and time in the past to match when the original order was created.
The website where the customer clicked a link to the shop.
The mailing address to where the order will be shipped.
An array of objects, each of which details a shipping method used.
The ID of the order placed on the originating platform. This value doesn't correspond to the Shopify ID that's generated from a completed draft.
The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. You can register the channels that your app is managing by completing this Google Form. After you've submited your request, you need to wait for your request to be processed by Shopify. You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension. You can specify a handle as the source_name value in your request.
A valid URL to the original order on the originating surface. This URL is displayed to merchants on the Order Details page. If the URL is invalid, then it won't be displayed.
A comma separated list of tags that have been added to the draft order.
Whether taxes are included in the order subtotal.
An array of tax line objects, each of which details a tax applicable to the order. When creating an order through the API, tax lines can be specified on the order or the line items but not both. Tax lines specified on the order are split across the taxable line items in the created order.
Whether this is a test order.
The payment transactions to create for the order.
The ID of the user logged into Shopify POS who processed the order, if applicable.