Home > Application Reference > Magento > Read Order

Read Order

Read order info.

Input Fields

  • Customer
    • Customer ID (number): Identification number associated with customer.

Output Fields

  • Order Info

    • Base Currency Code (text)Code for the primary currency used for all online payment transactions. For multiple store views, the scope of the price must be set in the Catalog configuration. (Eg. of a Currency Code of United States: USS 998).
    • Base Discount Amount (number): amount discounted from defaultamount.
    • Base Grand Total (number): Grant total of default amount.
    • Base Discount Tax Compensation Amount(number): Amount of discount from tax deduction for default amount.
    • Base Shipping Amount (number): Shipping for default amount.
    • Base Shipping Incl Tax (number): Shipping total of default amount with tax included.
    • Base Shipping Tax Amount (number): Amount of tax from default shipping amount.
    • Base Subtotal (number): Subtotal for default amount.
    • Base Subtotal Incl Tax (number): Subtotal with tax included for default amount.
    • Base Tax Amount (number): Value in the default store currency
    • Base To Global Rate (number): Conversion rate from base to global currency.
    • Base To Order Rate (number): Conversion rate from base to order currency.
    • Billing Address ID (number): Identification code of address.
    • Created At (text):  Date invoice was created at.
    • Customer Date Of Birth (text): Date of birth of customer (Eg. Format MM/DD/YYYY).
    • Customer Email (text): Email of customer.
    • Customer First Name (text): First name of customer.
    • Customer Gender (text): Gender orientation of customer (Eg. Female, Male, other).
    • Customer Group ID (number): Identification number of group customer is associated with.
    • Customer ID (number): Identification number of customer.
    • Is Customer Guest? (true/false): If true, customer is on a guest account.
    • Customer Last Name (text): Last name/Family name of customer.
    • Customer Middle Name (text): Middle name of customer.
    • Customer Note (text): Note to customer.
    • Customer Note Notify? (true/false): If true, notify to the customer there is a note for them.
    • Customer Prefix (text):  Title before the customer’s full name and provides additional information often indicating academic career and gender (Eg. Mr, Ms, Mrs, Dr.)
    • Customer Suffix (text): Suffix follows customer’s full name and provides additional information about the person.(E.g. PhD, Jr, Snr).
    • Discount Amount (number): Amount discounted from original price.
    • Email Sent? (true/false): If true, email has been sent.
    • Entity ID (number): Identification code associated with specific entity.
    • Global Currency Code (text): Code for global currency (Eg. Code of the US dollar, Euro, or Yen).
    • Grand Total (number): Current currency of grand total.
    • Discount Tax Compensation Amount (number):  Amount of discount from tax deduction for selected amount.
    • Increment ID (text): Identification code of Increment.
    • Is Virtual? (true/false): If true, product customer has ordered is a virtual product (Eg. Membership, Service, Warranty).
    • Order Currency Code (text): Three-letter alphabetic codes that represent the various currencies used throughout the world. ISO Currency Codes are specified by the International Organization for Standardization (ISO), which provides standards for businesses, governments and societies.
    • Protect Code (text): A code created to protect trade secrets for customer information.
    • Quote ID (number): Identification number of quote associated with product.
    • Shipping Amount (number): Rate/Cost of shipping.
    • Shipping Discount Tax Compensation Amount(number)
    • Shipping Incl Tax (number): Cost of shipping, including taxed portion.
    • Shipping Tax Amount (number): Cost of tax for shipping.
    • State: (number): State/Step order is currently on (Canceled, On Hold, Pending Payment)
    • Store Currency Code (text): Code of selected store currency.
    • Store ID (number): Identification code of customer’s store.
    • Store To Base Rate (number): Conversion rate from store and base currency.
    • Store To Order Rate (number): Conversion rate from store to order currency.
    • Subtotal (number): the total of one set of a larger group of figures to be added.
    • Subtotal Incl Tax (number): Subtotal with tax calculated in.
    • Tax Amount (number): Value in the selected store currency.
    • Total Due (number): Total amount due from
    • Total Item Count (number): Total number of items associated with order.
    • Total Quantity Ordered (number): Quantity of items ordered.
    • Updated At (text): Date of most recent update of invoice.
    • Weight (number): Weight of shipment.
    • Items (object): Types of items included within invoice.
    • Items (object): Types of items ordered.
    • Status Histories (object): History of total customer statuses.
    • Shipping Assignments (object): Total assigned to be included in shipping package.

  • Billing Address

    • Address Type (text): Format of billing address (Eg. Text, Text One Line, HTML).
    • City (text): City of billing address.
    • Company (text): Company associate with billing address.
    • Country ID (text): Identification code associated with county of billing address.
    • Customer Address ID (number):
    • Email (text): Email address associated with billing address.
    • Entity ID (number)
    • Fax (text): Fax address associated with billing address.
    • First Name (text): First name of customer.
    • Last Name (text): Last name of customer.
    • Middle Name (text): Middle name of customer.
    • Parent ID (number): Identification number of product parent.
    • Postcode (text): A group of numbers or letters and numbers that are added to a postal address to assist the sorting of mail. (Eg. 00000 American addresses usually have a 5 number code)
    • Prefix (text): The district governed by the customer’s prefect.
    • Region (text): The basic unit of geography divided by land distribution (Eg. U.S. Territories).
    • Region Code (text): Codes associated with specific regions within the world.
      • R0 Region o - Free
      • R1 Region 1 ~ U.S.A., U.S. Territories and Canada
      • R2 Region 2 ~ Europe, Japan, the Middle East, Egypt, South Africa, Greenland
      • R3 Region 3 ~ Taiwan, Korea, the Philippines, Indonesia, Hong Kong
      • R4 Region 4 ~ Mexico, South and Central America, Australia, New Zealand, Pacific Islands, Caribbean
      • R5 Region 5 ~ Russia, Eastern Europe, India, Africa (excluding South Africa), North Korea, Mongolia
      • R6 Region 6 ~ China
    • Street (text): Building number and street associated with billing address.
    • Suffix (text): follows a person’s full name and provides additional information about the person.(E.g. PhD, Jr, Snr).
    • Telephone (text): Phone number associated to billing address.
    • Vat ID (text): A value added tax identification number or VAT identification (VATID) is an identifier used in many countries, including the countries of the European Union, for value added tax purposes.

  • Payment Info

    • Amount Ordered (number): Total price amount ordered.
    • Base Amount Ordered (number): Default amount ordered.
    • Base Shipping Amount (number): Default of amount included in shipment.
    • Cc Exp Year (number): Credit card expiration year.
    • Cc Ss Start Month (number): Credit card ss start month.
    • Cc Ss Start Year (number): Credit card ss start year.
    • Entity ID (number): Identification number of entity customer is associated with.
    • Payment Method (text): Method of customer payment (Eg. PayPal, Mastercard, Debit)
    • Parent ID (number): Identification number of product parent.
    • Shipping Amount (number): Total amount of items in shipment.
    • Additional Information (text): Additional information/notes about order (Eg. Fragile).