X

Events

Actions

Home > Application Reference > Magento

Jump to a Section

Events

  • New Credit Memo

    Start FLO when a new Credit Memo is created in Magento.

  • New Customer

    Start FLO when a new Customer is created in Magento.

  • New Invoice

    Start FLO when a new Invoice is created in Magento.

  • New Order

    Start FLO when a new Order is created in Magento.

  • New Shipment

    Start FLO when a new Shipment is created in Magento.

Actions

  • Build Address Object For Customer

    Build address for customer

  • Cancel Order

    Cancel order from Magento data base.

    Input Fields

    • Order
      • Order ID* (number): Identification number of order.

    Output Fields

    • There are no output fields

  • Create Customer

    Create new customer for Magento data base.

    Input Fields

    • Email* (text): E-mail of new customer.
    • First Name* (text): First name of new customer.
    • Last Name* (text): Last name of new customer.
    • Group ID (number): Identification code of customer group.
    • Middle Name (text): Middle name of new customer.
    • Prefix (text): Group of letters placed before first name signifying marital or educational status (Eg. Mr., Mrs., Dr., and Ms).
    • Suffix (text): Explanation of customer’s first name, not the last. “John Doe Jr.” means he is John, the son of John.
    • Gender (text): the state of being male or female or other.
    • Store ID (number): Identification code of customer’s store.
    • Taxvat (text): Value added Tax (VAT)
    • Website ID (number): Identification code of customer’s website.
    • Default Billing (text): Default billing address for new customer.
    • Default Shipping (text): Default shipping address for new customer.
    • Date of Birth (text): Date customer was born on.
    • Confirmation (text): Confirmation to send to customer email.
    • Address (drop down list): Select from drop down menu to which address

    Output Fields

    • Customer ID (text): Identification code of new customer.

  • Create Invoice

    Create an invoice stored in Magento from an existing order.

    Input Fields

    • Order
      • Order ID (number): Identification number of order.

    Output Fields

    • Invoice List (text): Fields generated as part of the invoice created.

    What is an invoice?

  • Delete Customer

    Delete Customer

    Deletes customer from Magento data base.

    Input Fields

    • Customer 
      • Customer ID* (number): Identification number of Magento customer.

    Output Fields

    • There are no output fields

  • Hold Order

    Hold order in Magento data base.

    Input Fields

    • Order
      • Order ID* (number): Identification number of order.

    Output Fields

    • There are no output fields

  • Read Customer

    Reads customer profile search in Magento data base.

    Input Fields

    • Customer ID (text): Identification code of new customer.

    Output Fields

    • Group ID (true or false): If marked “true”, customer is assigned to group code. Identification code of customer group.
    • Default Billing (text): Default billing address for new customer.
    • Default Shipping (text): Default shipping address for new customer.
    • Created At (text): Date customer was added to Magento data base.
    • Updated At (text): Date customer’s profile was last updated.
    • Created In (text): Place within Magento customer’s profile was created in.
    • Date of Birth (text): Date customer was born on.
    • Email* (text): E-mail of new customer.
    • First Name* (text): First name of new customer.
    • Last Name* (text): Last name of new customer.
    • Middle Name (text): Middle name of new customer.
    • Prefix (text): Group of letters placed before first name signifying marital or educational status (Eg. Mr., Mrs., Dr., and Ms).
    • Suffix (text): Explanation of customer’s first name, not the last. “John Doe Jr.” means he is John, the son of John.
    • Gender (text): the state of being male or female or other.
    • Store ID (true or false): If “true” is marked, customer has a store ID, if null this information is not applicable. Identification code of customer’s store.
    • Taxvat (text): : If “true” is marked, customer has a taxvat number. If null this information is not applicable.Value added Tax (VAT)
    • Website ID (number): : If “true” is marked, customer has a Website ID. If null this information is not applicable. Identification code of customer’s website.
    • Address (drop down list): Select from drop down menu to which address

      Click here for more information

  • Read Invoices

    Search Invoices

    Search invoices stored in Magento.

    Input Fields

    • Invoice 
      • Invoice ID (number): Identification number associated with invoice.

    Output Fields

    • Invoice 

      • 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
      • Can Void Flag? (true/false): If true, void is able to flag.
      • Created At (text): Date invoice was created at.
      • Discount Amount (number): Amount to take out as discount from total.
      • 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.
      • Order Currency Code (text): Currency code of order.
      • Order ID (number): Identification code of order. 
      • Shipping Address ID (number): Identification code of shipping address for invoice.
      • 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 Quantity (number): Total quantity of invoice.
      • Updated At (text): Date of most recent update of invoice.
      • Items (object): Types of items included within invoice.
      • Comments (object): Comments included within invoice.

      What is an invoice? What is the difference between a base amount and an amount?

  • 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).

  • Search Customers

    Search customers in Magenta data base.

    Input Fields

    • Comparison Value
      • Value * (text): Identification of customer (First Name/Identification Code/etc..)

    Output Fields

    • Customers List * (list): List of customers which fit the input value along with their information.

  • Search Invoices

    Search Customers in Magento.

  • Search Order

    Search Order

    Search order in Magento data base.

    Input Fields

    • Comparison Value
      • Value (text): Enter in certain value used to identify order (Identification ID, Name, etc…)

    Output Fields

    • Order List (drop down menu): List of all orders fitting search criteria.

  • Unhold Order

    UnHold order in Magento data base.

    Input Fields

    • Order
      • Order ID* (number): Identification number of order.

    Output Fields

    • There are no output fields

  • Update Customer

    customer for Magento data base.

    Input Fields

    • Customer ID (text): Identification code of new customer.

    Output Fields

    • Group ID (number): Identification code of customer group.
    • Default Billing (text): Default billing address for new customer.
    • Default Shipping (text): Default shipping address for new customer.
    • Created In (text): Place within Magento customer’s profile was created in.
    • Date of Birth (text): Date customer was born on.
    • Email (text): E-mail of new customer.
    • First Name (text): First name of new customer.
    • Last Name (text): Last name of new customer.
    • Middle Name (text): Middle name of new customer.
    • Prefix (text): Group of letters placed before first name signifying marital or educational status (Eg. Mr., Mrs., Dr., and Ms).
    • Suffix (text): Explanation of customer’s first name, not the last. “John Doe Jr.” means he is John, the son of John.
    • Gender (drop down menu): the state of being male or female.
    • Store ID (number): Identification code of customer’s store.
    • Taxvat (text): Value added Tax (VAT)
    • Website ID (number): Identification code of customer’s website.
    • Confirmation (text): Confirmation to send to customer email.
    • Address (drop down list): Select from drop down menu to which address