Skip to content

OrderAdd.md

Latest commit

 

History

History
86 lines (78 loc) · 7.06 KB

OrderAdd.md

File metadata and controls

86 lines (78 loc) · 7.06 KB

OrderAdd

Properties

Name Type Description Notes
id String Defines order's id [optional]
orderId String Defines the order id if it is supported by the cart [optional]
storeId String Defines store id where the order should be assigned [optional]
channelId String Channel ID [optional]
orderStatus String Defines order status.
fulfillmentStatus String Create order with fulfillment status [optional]
financialStatus String Create order with financial status [optional]
customerEmail String Defines the customer specified by email for whom order has to be created
customerFirstName String Specifies customer's first name [optional]
customerLastName String Specifies customer’s last name [optional]
customerPhone String Specifies customer’s phone [optional]
customerCountry String Specifies customer's address ISO code or name of country [optional]
customerBirthday String Specifies customer’s birthday [optional]
customerFax String Specifies customer’s fax [optional]
isGuest Boolean Indicates whether the customer is a guest customer [optional]
orderPaymentMethod String Defines order payment method.<br/>Setting order_payment_method on Shopify will also change financial_status field value to 'paid' [optional]
transactionId String Payment transaction id [optional]
currency String Currency code of order [optional]
date String Specifies an order creation date in format Y-m-d H:i:s [optional]
dateModified String Specifies order's modification date [optional]
dateFinished String Specifies order's finished date [optional]
billFirstName String Specifies billing first name
billLastName String Specifies billing last name
billAddress1 String Specifies first billing address
billAddress2 String Specifies second billing address [optional]
billCity String Specifies billing city
billPostcode String Specifies billing postcode
billState String Specifies billing state code
billCountry String Specifies billing country code
billCompany String Specifies billing company [optional]
billPhone String Specifies billing phone [optional]
billFax String Specifies billing fax [optional]
shippFirstName String Specifies shipping first name [optional]
shippLastName String Specifies shipping last name [optional]
shippAddress1 String Specifies first shipping address [optional]
shippAddress2 String Specifies second address line of a shipping street address [optional]
shippCity String Specifies shipping city [optional]
shippPostcode String Specifies shipping postcode [optional]
shippState String Specifies shipping state code [optional]
shippCountry String Specifies shipping country code [optional]
shippCompany String Specifies shipping company [optional]
shippPhone String Specifies shipping phone [optional]
shippFax String Specifies shipping fax [optional]
subtotalPrice BigDecimal Total price of all ordered products multiplied by their number, excluding tax, shipping price and discounts [optional]
taxPrice BigDecimal The value of tax cost for order [optional]
totalPrice BigDecimal Defines order's total price [optional]
totalPaid BigDecimal Defines total paid amount for the order [optional]
totalWeight Int Defines the sum of all line item weights in grams for the order [optional]
pricesIncTax Boolean Indicates whether prices and subtotal include tax. [optional]
shippingPrice BigDecimal Specifies order's shipping price [optional]
shippingTax BigDecimal Specifies order's shipping price tax [optional]
discount BigDecimal Specifies order's discount [optional]
couponDiscount BigDecimal Specifies order's coupon discount [optional]
giftCertificateDiscount BigDecimal Discounts for order with gift certificates [optional]
orderShippingMethod String Defines order shipping method [optional]
carrierId String Defines tracking carrier id [optional]
warehouseId String This parameter is used for selecting a warehouse where you need to set/modify a product quantity. [optional]
coupons Seq<String> Coupons that will be applied to order [optional]
tags String Order tags [optional]
comment String Specifies order comment [optional]
adminComment String Specifies admin's order comment [optional]
adminPrivateComment String Specifies private admin's order comment [optional]
sendNotifications Boolean Send notifications to customer after order was created [optional]
sendAdminNotifications Boolean Notify admin when new order was created. [optional]
externalSource String Identifying the system used to generate the order [optional]
inventoryBehaviour String The behaviour to use when updating inventory.<hr><div style=&quot;font-style:normal&quot;>Values description:<div style=&quot;margin-left: 2%; padding-top: 2%&quot;><div style=&quot;font-size:85%&quot;><b>bypass</b> = Do not claim inventory </br></br><b>decrement_ignoring_policy</b> = Ignore the product's </br> inventory policy and claim amounts</br></br><b>decrement_obeying_policy</b> = Obey the product's </br> inventory policy.</br></br></div></div></div> [optional]
createInvoice Boolean Defines whether the invoice is created automatically along with the order [optional]
invoiceAdminComment String Specifies admin's order invoice comment [optional]
noteAttributes Seq<OrderAddNoteAttributesInner> Defines note attributes [optional]
clearCache Boolean Is cache clear required [optional]
origin String The source of the order [optional]
feePrice BigDecimal Specifies refund's fee price [optional]
idempotencyKey String A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong> [optional]
orderItem Seq<OrderAddOrderItemInner>