SalesDataOrderInterface

May 18, 2017 ยท View on GitHub

Properties

NameTypeDescriptionNotes
adjustmentNegativefloatNegative adjustment value.[optional]
adjustmentPositivefloatPositive adjustment value.[optional]
appliedRuleIdsstringApplied rule IDs.[optional]
baseAdjustmentNegativefloatBase negative adjustment value.[optional]
baseAdjustmentPositivefloatBase positive adjustment value.[optional]
baseCurrencyCodestringBase currency code.[optional]
baseDiscountAmountfloatBase discount amount.[optional]
baseDiscountCanceledfloatBase discount canceled.[optional]
baseDiscountInvoicedfloatBase discount invoiced.[optional]
baseDiscountRefundedfloatBase discount refunded.[optional]
baseGrandTotalfloatBase grand total.
baseDiscountTaxCompensationAmountfloatBase discount tax compensation amount.[optional]
baseDiscountTaxCompensationInvoicedfloatBase discount tax compensation invoiced.[optional]
baseDiscountTaxCompensationRefundedfloatBase discount tax compensation refunded.[optional]
baseShippingAmountfloatBase shipping amount.[optional]
baseShippingCanceledfloatBase shipping canceled.[optional]
baseShippingDiscountAmountfloatBase shipping discount amount.[optional]
baseShippingDiscountTaxCompensationAmntfloatBase shipping discount tax compensation amount.[optional]
baseShippingInclTaxfloatBase shipping including tax.[optional]
baseShippingInvoicedfloatBase shipping invoiced.[optional]
baseShippingRefundedfloatBase shipping refunded.[optional]
baseShippingTaxAmountfloatBase shipping tax amount.[optional]
baseShippingTaxRefundedfloatBase shipping tax refunded.[optional]
baseSubtotalfloatBase subtotal.[optional]
baseSubtotalCanceledfloatBase subtotal canceled.[optional]
baseSubtotalInclTaxfloatBase subtotal including tax.[optional]
baseSubtotalInvoicedfloatBase subtotal invoiced.[optional]
baseSubtotalRefundedfloatBase subtotal refunded.[optional]
baseTaxAmountfloatBase tax amount.[optional]
baseTaxCanceledfloatBase tax canceled.[optional]
baseTaxInvoicedfloatBase tax invoiced.[optional]
baseTaxRefundedfloatBase tax refunded.[optional]
baseTotalCanceledfloatBase total canceled.[optional]
baseTotalDuefloatBase total due.[optional]
baseTotalInvoicedfloatBase total invoiced.[optional]
baseTotalInvoicedCostfloatBase total invoiced cost.[optional]
baseTotalOfflineRefundedfloatBase total offline refunded.[optional]
baseTotalOnlineRefundedfloatBase total online refunded.[optional]
baseTotalPaidfloatBase total paid.[optional]
baseTotalQtyOrderedfloatBase total quantity ordered.[optional]
baseTotalRefundedfloatBase total refunded.[optional]
baseToGlobalRatefloatBase-to-global rate.[optional]
baseToOrderRatefloatBase-to-order rate.[optional]
billingAddressIdintBilling address ID.[optional]
canShipPartiallyintCan-ship-partially flag value.[optional]
canShipPartiallyItemintCan-ship-partially-item flag value.[optional]
couponCodestringCoupon code.[optional]
createdAtstringCreated-at timestamp.[optional]
customerDobstringCustomer date-of-birth (DOB).[optional]
customerEmailstringCustomer email address.
customerFirstnamestringCustomer first name.[optional]
customerGenderintCustomer gender.[optional]
customerGroupIdintCustomer group ID.[optional]
customerIdintCustomer ID.[optional]
customerIsGuestintCustomer-is-guest flag value.[optional]
customerLastnamestringCustomer last name.[optional]
customerMiddlenamestringCustomer middle name.[optional]
customerNotestringCustomer note.[optional]
customerNoteNotifyintCustomer-note-notify flag value.[optional]
customerPrefixstringCustomer prefix.[optional]
customerSuffixstringCustomer suffix.[optional]
customerTaxvatstringCustomer value-added tax (VAT).[optional]
discountAmountfloatDiscount amount.[optional]
discountCanceledfloatDiscount canceled.[optional]
discountDescriptionstringDiscount description.[optional]
discountInvoicedfloatDiscount invoiced.[optional]
discountRefundedfloatDiscount refunded amount.[optional]
editIncrementintEdit increment value.[optional]
emailSentintEmail-sent flag value.[optional]
entityIdintOrder ID.[optional]
extCustomerIdstringExternal customer ID.[optional]
extOrderIdstringExternal order ID.[optional]
forcedShipmentWithInvoiceintForced-shipment-with-invoice flag value.[optional]
globalCurrencyCodestringGlobal currency code.[optional]
grandTotalfloatGrand total.
discountTaxCompensationAmountfloatDiscount tax compensation amount.[optional]
discountTaxCompensationInvoicedfloatDiscount tax compensation invoiced amount.[optional]
discountTaxCompensationRefundedfloatDiscount tax compensation refunded amount.[optional]
holdBeforeStatestringHold before state.[optional]
holdBeforeStatusstringHold before status.[optional]
incrementIdstringIncrement ID.[optional]
isVirtualintIs-virtual flag value.[optional]
orderCurrencyCodestringOrder currency code.[optional]
originalIncrementIdstringOriginal increment ID.[optional]
paymentAuthorizationAmountfloatPayment authorization amount.[optional]
paymentAuthExpirationintPayment authorization expiration date.[optional]
protectCodestringProtect code.[optional]
quoteAddressIdintQuote address ID.[optional]
quoteIdintQuote ID.[optional]
relationChildIdstringRelation child ID.[optional]
relationChildRealIdstringRelation child real ID.[optional]
relationParentIdstringRelation parent ID.[optional]
relationParentRealIdstringRelation parent real ID.[optional]
remoteIpstringRemote IP address.[optional]
shippingAmountfloatShipping amount.[optional]
shippingCanceledfloatShipping canceled amount.[optional]
shippingDescriptionstringShipping description.[optional]
shippingDiscountAmountfloatShipping discount amount.[optional]
shippingDiscountTaxCompensationAmountfloatShipping discount tax compensation amount.[optional]
shippingInclTaxfloatShipping including tax amount.[optional]
shippingInvoicedfloatShipping invoiced amount.[optional]
shippingRefundedfloatShipping refunded amount.[optional]
shippingTaxAmountfloatShipping tax amount.[optional]
shippingTaxRefundedfloatShipping tax refunded amount.[optional]
statestringState.[optional]
statusstringStatus.[optional]
storeCurrencyCodestringStore currency code.[optional]
storeIdintStore ID.[optional]
storeNamestringStore name.[optional]
storeToBaseRatefloatStore-to-base rate.[optional]
storeToOrderRatefloatStore-to-order rate.[optional]
subtotalfloatSubtotal.[optional]
subtotalCanceledfloatSubtotal canceled amount.[optional]
subtotalInclTaxfloatSubtotal including tax amount.[optional]
subtotalInvoicedfloatSubtotal invoiced amount.[optional]
subtotalRefundedfloatSubtotal refunded amount.[optional]
taxAmountfloatTax amount.[optional]
taxCanceledfloatTax canceled amount.[optional]
taxInvoicedfloatTax invoiced amount.[optional]
taxRefundedfloatTax refunded amount.[optional]
totalCanceledfloatTotal canceled.[optional]
totalDuefloatTotal due.[optional]
totalInvoicedfloatTotal invoiced amount.[optional]
totalItemCountintTotal item count.[optional]
totalOfflineRefundedfloatTotal offline refunded amount.[optional]
totalOnlineRefundedfloatTotal online refunded amount.[optional]
totalPaidfloatTotal paid.[optional]
totalQtyOrderedfloatTotal quantity ordered.[optional]
totalRefundedfloatTotal amount refunded.[optional]
updatedAtstringUpdated-at timestamp.[optional]
weightfloatWeight.[optional]
xForwardedForstringX-Forwarded-For field value.[optional]
items\SpringImport\Swagger\Magento2\Client\Model\SalesDataOrderItemInterface[]Array of items.
billingAddress\SpringImport\Swagger\Magento2\Client\Model\SalesDataOrderAddressInterface[optional]
payment\SpringImport\Swagger\Magento2\Client\Model\SalesDataOrderPaymentInterface[optional]
statusHistories\SpringImport\Swagger\Magento2\Client\Model\SalesDataOrderStatusHistoryInterface[]Array of status histories.[optional]
extensionAttributes\SpringImport\Swagger\Magento2\Client\Model\SalesDataOrderExtensionInterface[optional]

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