Sign In Exigo Web Services API This reference includes full documentation and code samples that can be integrated into your applications right away. It utilizes the standard SOAP protocol for all request and responses. Clients can be written in .Net, Java, PHP, or any network stack capable of posting HTTP under SSL. Overview Customers Orders/Payments Recurring Orders Items Tree Movement Payout Reporting Communications Party Plan Points/Subscriptions Calendar Customer Leads Users Files/Folders Web Content Extended DB Other Customers Customer management protocols for creating, updating, and administering customer entitys. This section also contains tools for tree placement, billing, and social media integration, along with customer site management. CreateCustomer Creates a new Customer. Can optionally be put in one or more trees. UpdateCustomer Updates one or more fields on an existing customer. Can participate in a transaction. AuthenticateCustomer Authenticates a customer for login using UserName and Password combination. SetAccountCreditCardToken Setup primary or secondary credit card token on file for an existing customer, or new customer in a transaction. SetAccountChecking Setup bank account on file an existing customer, or new customer in a transaction. You can also empty the account settings by simply leaving everything but CustomerID empty. SetAccountDirectDeposit Setup direct deposit info for an existing customer, or new customer in a transaction. You can also empty the account settings by simply leaving everything but CustomerID empty. SetAccountWallet Setup primary or secondary wallet account on file for an existing customer, or new customer in a transaction. SetCustomerSite Setup public web site info for an existing customer, or new customer in a transaction. SetCustomerSiteImage Setup public web site image for an existing customer. GetCustomers Returns one or more customers that match the filter critera passed in. GetCustomerSite Returns the public web site info setup for a customer. Pass in CustomerID or WebAlias. GetCustomerBilling Returns billing accounts on file for a customer. Only => s last four digits of a credit card. GetCustomerNotes Returns the notes field for one or more customers that match the filter critera passed in. AppendCustomerNotes Appends a specified value to the specified Customer's Notes record GetAccountDirectDeposit Returns direct deposit info for an existing customer. CreateCustomerExtended Creates a new customer extended record. UpdateCustomerExtended Updates one customer extended record. GetCustomerExtended Returns extended properties setup for a customer. DeleteCustomerExtended Removes one customer extended record. SetCustomerSocialNetworks Deletes all existing social network(s) for the customer, then inserts the provided list of social network(s) for the customer. GetCustomerSocialNetworks Returns a list of social network(s) for the customer. GetCustomerWall Get wall item(s) from CustomerWall table. CreateCustomerWallItem Create new wall item in CustomerWall table. DeleteCustomerWallItem Delete wall item(s) from CustomerWall table. CreateCustomerInquiry Creates a customer history record. DequeueCustomerEvents This will 'pop' the oldest 100 customer events off the event queue. Orders/Payments A robust API for handling all transaction functions, including batch orders, invoicing, payment methods, and more. Full authentication is provided to support credit, debit and ACH transactions. ProcessTransaction Commits multiple requests in one step. All business rules are checked before commit and it is a commit-all or fail-all. CalculateOrder Calculates pricing, tax, shipping and volume info for a potential order. This is for calculation only and does not store a permanent record. Client provides address, itemcodes, and quantity. Server calculates and => s pricing, tax, shipping and volume info. CreateOrder Creates a new Order for an existing customer. Can create an order for a new customer if part of a transaction. Server will calculate all pricing, tax, shipping and volume info unless overridden in the request. CreateOrderImport Imports a new Order for an existing customer. Use this for import routines or other instances where you wish to supply all calculation data. It is advised to use CreateOrder unless you know the exact breakdown of all pricing, tax, shipping and volume info. UpdateOrder Updates one or more fields on an existing order. Can participate in a transaction. ChangeOrderStatus Changes an existing order from one status to another. ChangeOrderStatusBatch Changes existing orders from one status to another in a batch. Can optionally update tracking numbers as well. ValidateCreditCardToken Validates a credit card token. CreatePayment Creates a new payment type using cash, money order etc. CreatePaymentCreditCard Creates a specific credit card payment for an existing order, or a new order in a transaction. Note: This does not charge a card, and you must have an authorization code to submit this. CreatePaymentWallet Creates a new payment for wallet account. CreatePaymentPointAccount Creates a new payment for point account. CreatePaymentCheck Creates a new payment using check information. ChargeCreditCardToken Attempts to charge a card token with the amount found on an exiting order, or a new order in a transaction.If the charge is successful, the order is changed to accepted. ChargeCreditCardTokenOnFile Attempts to charge a card token on file with the amount found on an exiting order, or a new order in a transaction. If the charge is successful, the order is changed to accepted. ChargeGroupOrderCreditCardToken Attempts to charge a card token with the amount found on the specified orders. RefundPriorCreditCardCharge Refunds a prior charge. To be used with an order. ChargeWalletAccount Attempts to debit a wallet account with the amount found on an exiting order, or a new order in a transaction. If the debit request is successful, the order is changed to accepted. ChargeWalletAccountOnFile Attempts to debit a wallet account with the amount found on an exiting order, or a new order in a transaction. If the debit request is successful, the order is changed to accepted. DebitBankAccount Attempts to debit a bank account with the amount found on an exiting order, or a new order in a transaction. If the debit request is successful, the order is changed to accepted. DebitBankAccountOnFile Attempts to debit a bank account on file with the amount found on an exiting order, or a new order in a transaction. If the debit request is successful, the order is changed to accepted. CreateExpectedPayment Creates a new expected payment type using cash, money order etc. CreateExpectedBankWire Creates a new expected payment of type Bank Bire. GetOrders Returns one or more orders. You can submit several optional filter fields to control the results. GetCountryRegions Returns countries setup for company as well as the regions for a single country requested. GetCustomerBalances Returns the sum of orders, payments, and adjustments per currency. CreateCustomerBalanceAdjustment Create an adjustment for a customer's account in a currency. RefundPriorWalletCharge Refunds a prior wallet charge. To be used with an order. GetOrderInvoice Returns an Rendered Order Invoice Recurring Orders CreateAutoOrder Create a new Recurring Order template for an existing customer or a new customer as part of a transaction. Client provides schedule, item codes, quantity, and shipping info. Server calculates and commits data, then pricing, tax, shipping and volume info. You can also update/overwrite an existing autoorder by using the OverwriteExistingAutoOrder and ExistingAutoOrderID properties. UpdateAutoOrder Update a Recurring Order template in or out of a transaction. Client provides schedule, item codes, quantity, and shipping info. Server calculates and commits data, then pricing, tax, shipping and volume info. UpdateAutoOrderDetail Update a Recurring Order template detail in or out of a transaction. Client provides quantity, pricing , volume and extended detail info. ChangeAutoOrderStatus Changes the status of an AutoOrder. This is typically used to delete or suspend an auto order. GetAutoOrders Returns any AutoOrders setup and active for a given customer. Items GetItems Returns price, volume, and description for one or more item codes. CreateItem Adds an Item (and optional warehouse/price info) UpdateItem Updates an Item (and optional warehouse/price info) SetItemPrice Sets pricing info for an item) SetItemWarehouse Sets warehouse info for an item) SetItemCountryRegion Sets country/region info for an item) SetItemImage Set Images for an Item CreateWebCategory Creates a new product web category. UpdateWebCategory Updates web category information. DeleteWebCategory Deletes a web category. AddProductsToCategory Adds items/products to a web category. DeleteProductFromCategory Deletes a product from a web category. GetWarehouses Gets a list of warehouses setup in the system. AdjustInventory Posts an adjustment to item inventory. SetItemKitMembers Sets the children for a static kit SetItemSubscription Set Item Subscriptions SetItemPointAccount Set Item Subscriptions Tree Movement PlaceEnrollerNode Inserts/Moves a customer within the Enroller Tree. PlaceUniLevelNode Inserts/Moves a customer within the UniLevel (Sponsor) Tree. PlaceMatrixNode Inserts/Moves a customer within the Matrix Tree. PlaceBinaryNode Inserts/Moves a customer within the Binary Tree. GetBinaryPreference Returns the currently configured placement preference for new placements under a customer. SetBinaryPreference Sets the placement preference for new placements under a customer. Payout CreatePayout Creates a new payout for one or more bills and updates status FundPaymentCard Creates a new payout and funds a payment card for one or more bills and updates status CreateBill Creates a new bill UpdateBill Updates one or more fields on an existing bill. Reporting GetDownline Gets nodes in a downline. GetUpline Gets nodes in an upline. GetVolumes Returns volume records for a current period in a periodtype. GetRealTimeCommissions Returns realtime commissions available for open periods. GetRealTimeCommissionDetail Returns realtime commission detail for a customer/bonus. GetRankQualifications Returns rank qualification report card. GetQualificationOverrides Returns Customer Overrides SetQualificationOverride Create or Edit a Customer Override DeleteQualificationOverride Delete a Customer Override GetCustomReport Returns a custom report in dataset format. Communications OptInEmail Setup opt in settings for Email by Email address. OptInSms Setup opt in settings for Sms messaging by phone number. OptInPushNotification Setup opt in settings for Push Notifications to mobile devices. OptOutEmail Opts out all customers and customer contacts with specified email from receiving broadcast emails. OptOutSms Opts out all customers and customer contacts with specified phone number from receiving broadcast SMS messages. OptOutPushNotification Setup opt out settings for Push Notifications to mobile devices. GetCompanyNews Gets a list of company news descriptions. GetCompanyNewsItem Gets company news details. GetRandomMessage Gets a random message (defined in the Exigo Admin). FireResponder Fires an email responder to customer or order email address on file. SendSms Sends an SMS message. Party Plan CreateParty Creates a new Party UpdateParty Updates selected Party instance GetParties Gets Parties list GetPartyGuests Gets a list of guests belonging to a party AddPartyGuests Adds one or more guests to a party. RemovePartyGuests Removes one or more guests from a party. CreateGuest Creates a new guest. Can optionally be put in a party. UpdateGuest Updates one or more fields on an existing guest. GetGuests Gets a list of guests GetGuestSocialNetworks Returns a list of social network(s) for the guest. SetGuestSocialNetworks Deletes all existing social network(s) for the guest, then inserts the provided list of social network(s) for the guest. Points/Subscriptions CreatePointTransaction Create a transaction that adjusts or redeems points from a customer's point account. GetPointAccount Get the balance of a point account for a customer. GetSubscription Get the subscription account for a customer. GetSubscriptions Get all subscriptions for a customer. Calendar CreateCalendarItem Creates a new calendar item. UpdateCalendarItem Updates calendar item information. DeleteCalendarItem Deletes a calendar item. Customer Leads GetCustomerLeads Gets a list of customer leads. CreateCustomerLead Creates a new customer lead. UpdateCustomerLead Updates a customer leads. DeleteCustomerLead Deletes a customer lead. SetCustomerLeadSocialNetworks Deletes all existing social network(s) for the customer lead, then inserts the provided list of social network(s) for the customer lead. GetCustomerLeadSocialNetworks Returns a list of social network(s) for the customer lead. Users AuthenticateUser Authenticates a corporate user for login using UserName and Password combination. GetUserPermissions Returns permissions associated with the corporate user account. Files/Folders Customer file and folder management operations CreateCustomerFolder Creates a folder for the customer in their default directory or a chosen parent folder. CreateCustomerFile Creates a file for the customer in their default directory DeleteCustomerFileFolder Deletes a file or folder for the customer in their default directory or a chosen parent folder. GetCustomerFolders Gets a list of customer folders. GetFiles Returns an array of files GetFileContents Returns a customer file for the given criteria MoveCustomerFile Moves a customer folder to a provided file. Web Content Language translations, content and resource set management operations ResourceSetCheckIn Keeps the client's version of the resource set up to date to the environment it is subscribed to. CreateResourceSet Create a new ResourceSet RetireResourceSet Retire an existing ResourceSet GetResourceSets Get an existing Resource Set UpdateResourceSet Update an existing ResourceSet CreateResourceSetIntItem Adds a ResourceSet Number Item to the ResourceSet CreateResourceSetDecimalItem Adds a ResourceSet Decimal Item to the ResourceSet CreateResourceSetTextItem Adds a ResourceSet Text Item to the ResourceSet CreateResourceSetBooleanItem Adds a ResourceSet CheckBox Item to the ResourceSet CreateResourceSetDateItem Adds a ResourceSet Date Item to the ResourceSet CreateResourceSetImageItem Adds a ResourceSet Image Item to the ResourceSet CreateResourceSetDataSetItem Adds a ResourceSet DataSet Item to the ResourceSet CreateResourceSetBannerItem Adds a ResourceSet Banner Item to the ResourceSet CreateResourceSetCarouselItem Adds a ResourceSet Carousel Item to the ResourceSet CreateResourceSetWidgetItem Adds a ResourceSet Widget Item to the ResourceSet CreateResourceSetDropDownItem Adds a ResourceSet DropDown Item to the ResourceSet DeleteResourceSetItem Deletes a ResourceSet Item GetResourceSetItems Gets ResourceSet Items UpdateResourceSetIntItem Updates a ResourceSet Int Item UpdateResourceSetDecimalItem Updates a ResourceSet Decimal Item UpdateResourceSetTextItem Updates a ResourceSet Text Item UpdateResourceSetBooleanItem Updates a ResourceSet Boolean Item UpdateResourceSetDateItem Updates a ResourceSet Date Item UpdateResourceSetImageItem Updates a ResourceSet Image Item UpdateResourceSetDataSetItem Updates a ResourceSet DataSet Item UpdateResourceSetBannerItem Updates a ResourceSet Banner Item UpdateResourceSetCarouselItem Updates a ResourceSet Carousel Item UpdateResourceSetWidgetItem Updates a ResourceSet Widget Item UpdateResourceSetDropDownItem Updates a ResourceSet DropDown Item CreateResourceSetCulture Adds a culture to a Resource Set DeleteResourceSetCulture Removes a cultue from a Resource Set GetResourceSetCultures Determines the cultures available in the resource set, environment, and version the client server is subscribed to. CreateResourceSetEnvironment Creates a ResourceSet Environment DeleteResourceSetEnvironment Deletes a ResourceSet Environment GetResourceSetEnvironments Gets ResourceSet Environments UpdateResourceSetEnvironment Updates a ResourceSet Environment CreateResourceSetGroup Creates a ResourceSet Group DeleteResourceSetGroup Deletes a ResourceSet Group GetResourceSetGroups Gets ResourceSet Groups UpdateResourceSetGroup Updates a ResourceSet Group CreateRelease Creates a Resource Set release DeleteRelease Deletes a Resource Set release GetReleases Gets Resource Set releases DeployRelease Deploys a Resource Set Release RevertToRecentRelease Reverts to most recent Resource Set Release Extended DB CreateExtendedDbSchema Create new Extended DB schema. GetExtendedDbSchema Get Extended DB schema. DeleteExtendedDbSchema Delete Extended DB schema. CreateExtendedDbEntity Create Extended DB Entity. GetExtendedDbEntity Get Extended DB Entity. UpdateExtendedDbEntity Update Extended DB Entity. DeleteExtendedDbEntity Delete Extended DB Entity. Other Validate Validates Business Rules. VerifyAddress Verifies and cleans up an address. GetSession Gets a generic session string for a unique sessionID. SetSession Sets a generic session string for a unique sessionID. CreateWarehouse Creates a new Warehouse GetApiWhitelist Get List of Whitelisted IP ranges CreateApiWhitelist Create a new Whitelisted IP range RemoveApiWhitelist Remove an existing Whitelisted IP range CreateAdminWhitelist Create a new Whitelisted IP range for Admin GetAdminWhitelist Get List of Whitelisted IP ranges for Admin RemoveAdminWhitelist Remove an existing Whitelisted IP range from Admin SendEmail Sends a specified Email using SendGrid © 2021 Exigo.