Skip to content

OrderAdd.md

Latest commit

 

History

History
82 lines (78 loc) · 7.25 KB

OrderAdd.md

File metadata and controls

82 lines (78 loc) · 7.25 KB

Org.OpenAPITools.Model.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 bool Indicates whether the customer is a guest customer [optional] [default to false]
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 decimal Total price of all ordered products multiplied by their number, excluding tax, shipping price and discounts [optional]
TaxPrice decimal The value of tax cost for order [optional] [default to 0M]
TotalPrice decimal Defines order's total price [optional]
TotalPaid decimal 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 bool Indicates whether prices and subtotal include tax. [optional] [default to false]
ShippingPrice decimal Specifies order's shipping price [optional] [default to 0M]
ShippingTax decimal Specifies order's shipping price tax [optional]
Discount decimal Specifies order's discount [optional]
CouponDiscount decimal Specifies order's coupon discount [optional]
GiftCertificateDiscount decimal 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 List<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 bool Send notifications to customer after order was created [optional] [default to false]
SendAdminNotifications bool Notify admin when new order was created. [optional] [default to false]
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] [default to "bypass"]
CreateInvoice bool Defines whether the invoice is created automatically along with the order [optional] [default to false]
NoteAttributes List<OrderAddNoteAttributesInner> Defines note attributes [optional]
ClearCache bool Is cache clear required [optional] [default to true]
Origin string The source of the order [optional]
FeePrice decimal 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 List<OrderAddOrderItemInner>

[Back to Model list] [Back to API list] [Back to README]