Order Create Order Input
The input fields for creating an order.
Anchor to FieldsFields
- Anchor to billingAddressbilling•Mailing
Address Address Input The mailing address associated with the payment method. This address is an optional field that won't be available on orders that don't require a payment method.
NoteIf a customer is provided, this field or
(which has precedence) will be set as the customer's default address. Additionally, if the provided customer is new or hasn't created an order yet then their name will be set to the first/last name from this address (if provided).
- Anchor to buyerAcceptsMarketingbuyer•BooleanDefault:null
Accepts Marketing Whether the customer consented to receive email updates from the shop.
- Anchor to closedAtclosed•Date
At Time The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
- Anchor to companyLocationIdcompany•ID
Location Id The ID of the purchasing company's location for the order.
- Anchor to currencycurrency•Currency
Code The shop-facing currency for the order. If not specified, then the shop's default currency is used.
- Anchor to customAttributescustom•[Order
Attributes Create Custom Attribute Input!] A list of extra information that's added to the order. Appears in the Additional details section of an order details page.
- Anchor to customercustomer•Order
Create Customer Input The customer to associate to the order.
- Anchor to discountCodediscount•Order
Code Create Discount Code Input A discount code applied to the order.
- Anchor to emailemail•String
A new customer email address for the order.
NoteIf a customer is provided, and no email is provided, the customer's email will be set to this field.
- Anchor to financialStatusfinancial•Order
Status Create Financial Status 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.
- Anchor to fulfillmentfulfillment•Order
Create Fulfillment Input The fulfillment to create for the order. This will apply to all line items.
- Anchor to fulfillmentStatusfulfillment•Order
Status Create Fulfillment Status The fulfillment status of the order. Will default to
unfulfilled
if not included.- Anchor to lineItemsline•[Order
Items Create Line Item Input!] The line items to create for the order.
- Anchor to metafieldsmetafields•[Metafield
Input!] A list of metafields to add to the order.
- Anchor to namename•String
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 the
id
property, 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.- Anchor to notenote•String
The new contents for the note associated with the order.
- Anchor to phonephone•String
A new customer phone number for the order.
- Anchor to poNumberpo•String
Number The purchase order number associated to this order.
- Anchor to presentmentCurrencypresentment•Currency
Currency Code 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.
- Anchor to processedAtprocessed•Date
At Time 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.
- Anchor to referringSitereferring•URL
Site The website where the customer clicked a link to the shop.
- Anchor to shippingAddressshipping•Mailing
Address Address Input The mailing address to where the order will be shipped.
NoteIf a customer is provided, this field (which has precedence) or
will be set as the customer's default address. Additionally, if the provided customer doesn't have a first or last name then it will be set to the first/last name from this address (if provided).
- Anchor to shippingLinesshipping•[Order
Lines Create Shipping Line Input!] An array of objects, each of which details a shipping method used.
- Anchor to sourceIdentifiersource•String
Identifier 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.
- Anchor to sourceNamesource•String
Name 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.
- Anchor to sourceUrlsource•URL
Url 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.
- •[String!]
A comma separated list of tags that have been added to the draft order.
- Anchor to taxesIncludedtaxes•BooleanDefault:false
Included Whether taxes are included in the order subtotal.
- Anchor to taxLinestax•[Order
Lines Create Tax Line Input!] 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.
- Anchor to testtest•BooleanDefault:false
Whether this is a test order.
- Anchor to transactionstransactions•[Order
Create Order Transaction Input!] The payment transactions to create for the order.
- Anchor to userIduser•ID
Id The ID of the user logged into Shopify POS who processed the order, if applicable.
- Anchor to customerIdcustomer•IDDeprecated
Id