This document covers the use of the Lizzy API, this API is a REST interface. The Lizzy API makes use of JSON objects for passing data between the client and the server. Before you can use the Lizzy API, you must be granted access by the customer you're wishing to do business with. To learn more about this option the Lizzy customer should watch video in Interface Setup Procedures 1.9) Controlling Who Has Access To Your Data.
\nNOTE: If you are making calls on behalf of more than one Lizzy customer then you will receive a different APIKey for each dealership or company. You will need to save these APIKeys as Lizzy uses them to determine which company you are working with.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"728439","collectionId":"de18dcd3-0e66-62a1-23bb-c84591a81432","publishedId":"7EEeZ39","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-11T15:38:22.000Z"},"item":[{"name":"orderstatus","id":"ee12f9bd-0e28-f872-d3a1-1dfaba037de4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","description":"Base64Encoded url string
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"payload","value":"{ordernumbers}:[\"1\"]}","type":"text","disabled":true}]},"url":"https://api.nizex.com/orderstatus?payload={\"ordernumbers\":\"8200685\"}","description":"This method is a GET request and requires two parameters APIKey and payload. The APIKey is the key provided to you when your access request was accepted. The APIKey will be passed in the header as a base64encoded() element. Payload will contain a JSON object named OrderNumbers or InvoiceNumbers. This object is a simple array containing the list of purchase order numbers that you want to retrieve. You can also pass in a list of InvoiceNumbers instead of OrderNumbers if you wish to check status on orders that were not processed through the API but entered directly into Lizzy.
\n\nNote: You can not pass both OrderNumbers and InvoiceNumbers in the same request. It doesn't matter which you want to use but you have to make 2 separate calls if you want to use both.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data. If multiple boxes were shipped for an order you will receive teh same PO or Invoice number multiple times, each with its own box# and tracking information.
\n\n\n Array\n (\n [0] => stdClass Object \n (\n [OrderNumber] => 1\n [InvoiceNumber] => 1001\n [Status] => Approved, Denied, Pending\n [BoxNumber] => 1\n [TrackingNumber] => 9400111969000940000011\n [ShipMethod] => UPS\n [DateShipped] => 2016-01-30\n [Parts]\n [0]=> stdClass Object\n (\n [PartNumber] => 12345\n [Qty] => 2\n [Cost] => 2.45\n [Discount] => 0\n [ExtCost] => 4.90\n )\n )...\n
This method is a GET request and requires parameters APIKey and Date with one limiting parameter for WebstoreID that is required to locate the respective invoices. The APIKey is the key provided to you when your access request was accepted. It will respond with all InvoiceNumbers generated with that were created in Lizzy manually and tagged for a specific site. This method is used to collect data from Lizzy on orders a customer might have placed via phone instead of closing them out directly through the respective store.
\n\nNote: The WebstoreID can be obtained by going to Settings → Webstore → Setup Webstore Interfaces and looking in parens beside the name field.
\n\n
The response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data. See appendix A for HTTP status codes.
Possible HTTP Return Codes:\n1) 500 - Internal Server Error, something went wrong on the server contact support\n2) 400 - Bad Request, something is wrong with the submitted request check the response text for details\n3) 204 - No Content, there was no data for the submitted request\n4) 201 - Created, a record was created for your submitted request\n5) 200 - OK, request was successful and data was found check the response text for the JSON Array\n\n\n Array\n (\n [0] => stdClass Object\n (\n [InvoiceNumber] => Internal Invoice Number in Lizzy\n )\n ...\n )\n","urlObject":{"protocol":"https","path":["externalorders"],"host":["api","nizex","com"],"query":[{"key":"apikey","value":"asdfadfadfasdf"}],"variable":[]}},"response":[],"_postman_id":"0d461b86-fd2c-6f1e-56c1-354e3e82ad73"},{"name":"orderdetails","id":"33b03dc2-ce70-96c3-346e-17d629924e66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","type":"text"}],"url":"https://api.nizex.com/orderdetails?payload={\"ordernumber\":\"454adfs4f\"}","description":"
This method is a GET request and requires two parameters APIKey and Payload which contains a JSON object with an (InvoiceNumber OR OrderNumber) to lookup. The APIKey is the key provided to you when your access request was accepted.The APIKey will be passed in the header as a base64encoded() element. InvoiceNumber is the invoice number from Lizzy you wish to get information on.
\n\nThe response will return an HTTP status code and the body will contain the response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n1){
\"InvoiceDate\": \"2021-06-08 18:07:51\",
\"ContactID\": \"98911\",
\"InvoiceNumber\": \"37446\",\n\"ShippingAmount\": \"0.00\",
\"ShipVia\": null,
\"Tax\": \"0.00\",
\"Total\": \"500.00\",
\"BusinessName\": \"titan\",
\"FirstName\": \"Astrid\",
\"LastName\": \"Beaowulf\",
\"EmailAddress\": \"testemail@testemail.com\",
\"Phone\": \"330-333-0023\",
\"Address\": \"001 Somwhere Ave\",
\"Address2\": \"\",
\"City\": \"HUBBARD\",
\"State\": \"Ohio\",
\"Zipcode\": \"44425\",
\"Country\": \"UNITED STATES\",
\"Parts\": [
{
\"VendorName\": \"Cyberdine Systems\",
\"ItemNumber\": \"000M999\",
\"Description\": \"Armat M999 Headlamp\",
\"Qty\": \"1.00000\",
\"ExtPrice\": \"500.00\"
},
{
\"VendorName\": \"Cyberdine Systems\",
\"ItemNumber\": \"000MTEST007\",
\"Description\": \"Test007\",
\"Qty\": \"1.00000\",
\"ExtPrice\": \"250.00\"
}
]
}
Array\n (\n [0] => stdClass Object\n (\n [ContactID] => 3 (Lizzy's Internal ContactID)\n [BusinessName] => Some Company\n [FirstName] => John\n [LastName] => Smith\n [EmailAddress] => jsmith@somecompany.com\n [Phone] => 7705154546\n [Address] => 123 45th St.\n [Address2] => \n [City] => Atlanta\n [State] => Georgia\n [Zipcode] => 30332\n [Country] => United States\n [InvoiceNumber] => 12345\n [InvoiceDate] => 2013-01-22 12:09:22\n [ShippingAmount => 10.95\n [ShipVia] => UPS\n [Tax] => 0\n [Total] => 22.01\n [Parts]\n [0] => stdClass Object\n (\n [VendorName] => Honda\n [ItemNumber] => 12345\n [Description] => Generator\n [Qty] => 1\n [ExtPrice] => 12.95\n )\n )\n ...\n )\n\nThis method is a GET request and requires the following parameters: APIKey, ContactID, StartDate, EndDate, SiteID and an optional field EmailAddress in the event you don't have the internal ContactID for Lizzy. The APIKey is the key provided to you when your access request was accepted. ContactID is the ID of the customer in the Lizzy system. Start and End Dates are the date range you wish to look at and the SiteID is an internal Webstore ID from Settings -> Webstore -> Webstore Interfaces so that the system retrieves the proper information for the site you're requesting from. The EmailAddress field should be supplied only if you don't know the ContactID and is not required.\n\n
Note: Start and End Dates expected to be in format of 4 digit Year/ Month / Date. ie: 2018/03/14
\nNote: Passing a SiteID of 0 will return invoices created at the dealership and NOT through a website.
\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n\n Array\n (\n [0] => stdClass Object \n (\n [InvoiceID] => 1001\n [ContactID] => 2000\n [InvoiceDate] => 2017-01-31 12:32:00\n [Total] => 100.00\n [Tax] => 5.00\n [Shipping] => 7.00\n [Type] => Counter, Service, Serialized, Internet or Phone In\n [Items]=> stdClass Object\n (\n [ItemNumber] => \"12345\"\n [Qty] => 3\n [List] => 4.00\n [Discount] => 0\n [ExtendedList] => 12.00\n )...\n )\n )\n
This method is a GET request and requires three parameters APIKey, LocationID and DateFrom. The APIKey is the key provided to you when your access request was added. DateFrom is the starting date that you want to use for producing the list of inventory and will return all items sold since or received since that time. So if you pass in 5 minutes ago it will send back all parts inventory that has been modified or sold in the last 5 minutes. DateTo is not required, but can be sent to pull data from a specific date range. It should be formatted the same as the DateFrom parameter. WebstoreID is not required but if sent will limit the response to only vendors that have been linked to that specific website.
\n\nNOTE: To retrieve the webstore id go to settings → webstore → setup webstore interface and look at the number in parens. LocationID can be found in settings → general → multi locations. If you are retrieving information for multiple dealers then you will need this information from each Lizzy customer.
\n\nThe DateFrom field supports both date and datetime values, the format is YYYY-MM-DD or YYYY-MM-DD HH:MI:SS. The LocationID is an integer field specified for the location (warehouse) you're interested in. Omit this variable if you want all inventory returned. You may also send a comma separated list like 1,3 and it will return inventory for locations 1 and 3. For information on what number to send for which location, speak with the Lizzy customer and have them provide the numbers from Settings → General → Multi-Locations.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n[{\"VendorID\":\"290\",\"MasterVendorID\":\"190\",\"VendorName\":\"Polaris\",\"ItemNumber\":\"5141917-626\",\"Description\":\"MOUNT-FOOTPEG,RH,BOB,BLK\",\"List\":\"199.9900\",\"Qty\":\"1.000\",\"ManufPartNum\":\"\",\"OnOrderQty\":null,\"PromisedQty\":\"1.0000\",\"ToBePulledQty\":\"0.000\",\"LastReceivedDate\":\"2023-10-10\", \"LastSoldDate\":\"2024-03-03\", \"MinQty\":\"1\", \"MaxQty\":\"3\",\"Supersession\":false,\"NLA\":\"\",\"Category\":\"Hard Parts - Polaris\",\"OrigManufPartNo\":\"\",\"OrigManuf\":\"\",\"MAP\":\"0.0000\",\"Bins\": [{\"BinName\":\"DG07F\", \"Qty\":\"1.000\"]},\"Cost\":\"100.00\",\"TrueCost\":\"91.28\",\"OverrideList\":\"\",\"OverrideCost\":\"\",\"Images\":[],\"BackorderETA\":\"2024-06-05\",\"BackorderNote\":\"\",\"UPC\":\"0123456789123\"}]
\n Array\n (\n [0] => stdClass Object\n (\n [VendorID] => Internal ID for this Vendor in Lizzy\n [MasterVendorID] => Master Vendor ID Shared across all Lizzy Dealerships\n [VendorName] => Name of Vendor in Lizzy\n [ItemNumber] => Actual Part number\n [Description] => Full description of item\n [Qty] => Total stock for item in Lizzy (Not location specific)\n [List] => List Price for part\n [ManufPartNum] => Vendor Part Number\n [Bins] => Names and Quantities of the Bins in Lizzy as an Array\n [Cost] => Cost for the part\n [TrueCost] => Latest Purchase Cost of Inventory\n [OverrideList] => Dealer Specified List Price\n [OverrideCost] => Dealer Specified Cost\n [OrigManuf] => Original Manufacturer of part in case ordering from supplier\n [OrigManufPartNo] => Original Manufacturer part number\n [NLA] => No Longer Available\n [Category] => Part Category assigned in Lizzy\n [MinQty] => Minimum reordering point\n [MaxQty] => Maximum reordering point \n [Supersession] => Number that supersedes this number\n [MAP] => Minimum Advertised Price\n [BackorderETA] => If backordered when is it expected to arrive\n [BackorderNote] => Any available note for the item on backorder \n [OnOrderQty] => How many are currently on open orders\n [PromisedQty] => How many are currently promised to customers from orders\n [ToBePulledQty] => How many items instock are spoken for already\n [LastReceivedDate] => Date Inventory was Last Received\n [LastSoldDate] => Latest Date the item was Sold\n [Images] => Image Object {\"URL\":Image URL, \"ImageType\": \"L\"}\n [UPC] => Universal Product Code\n )\n ...\n )\n\nRetrieved from dealer you want access to
\n","type":"text/plain"},"key":"apikey","value":"9be2f3d8-e169-48ef-92dc-ddb3825a93f7"},{"description":{"content":"Always 1 unless dealer has multiple locations to deal with
\n","type":"text/plain"},"key":"locationid","value":"1"},{"key":"datefrom","value":"2024-01-01 14:22:00"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"f74b7824-b5b1-da26-5bf5-1e958c7dd9d0"},{"name":"inventoryitem","id":"fd18a041-04e0-f335-5859-452fb1a931de","request":{"method":"GET","header":[],"url":"https://api.nizex.com/inventoryitem?apikey=sampleAPIKey&itemnumber=ItemNumber","description":"This method is a GET request and requires parameters APIKey and ItemNumber with two limiting parameters for VendorID and VendorName. The APIKey is the key provided to you when your access request was accepted. ItemNumber is required as is the APIKey but if you fail to give it a VendorID or a VendorName the response may include multiple entries where you will need to choose the one you wanted.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data. See appendix A for HTTP status codes.
\n\n[{\"VendorID\":\"84\",\"VendorName\":\"Tucker Rocky\",\"ItemNumber\":\"123456\",\"Description\":\"PFLOW BODY KT KXF WHT\",\"List\":\"169.9500\",\"Qty\":\"1.000\",\"ManufPartNum\":\"\",\"OnOrderQty\":\"0.000\",\"PromisedQty\":\"0.000\",\"ToBePulledQty\":\"0.000\",\"MinQty\":\"0\", \"MaxQty\":\"0\",\"Supersession\":\"\",\"NLA\":\"\",\"OrigManufPartNo\":\"1CYC-9307-42\",\"OrigManuf\":\"CYCRA\",\"MAP\":null,\"BackorderETA\":\"\",\"BackorderNote\":\"\",\"UPC\":\"0123456789123\",\"Bins\":[{\"BinName\":\"Misc\", \"Qty\":\"1.000\"},{\"BinName\":\"A-1\", \"Qty\": \"0.000\"}]}]
\n Array\n (\n [0] => stdClass Object\n (\n [VendorID] => Internal ID for this Vendor in Lizzy\n [VendorName] => Name of Vendor in Lizzy\n [ItemNumber] => Actual Part number\n [Description] => Full description of item\n [Qty] => Total stock for item in Lizzy (Not location specific)\n [List] => List Price for part\n [OrigManuf] => Original Manufacturer of part in case ordering from supplier\n [OrigManufPartNo] => Original Manufacturer part number\n [NLA] => No Longer Available\n [MinQty] => Minimum Reordering Point\n [MaxQty] => Maximum Reordering Point \n [Supersession] => Number that supersedes this number\n [MAP] => Minimum Advertised Price\n [BackorderETA] => If backordered when is it expected to arrive\n [BackorderNote] => Any available note for the item on backorder \n [OnOrderQty] => How many are currently on open orders\n [PromisedQty] => How many are currently promised to customers from orders\n [ToBePulledQty] => How many items instock are spoken for already\n [UPC] => Universal Product Code\n [Bins] => Array of Bin Locations and Quantities Assigned to the Item \n)\n ...\n )\n\nThis method is a GET request and requires two parameters APIKey and Payload. The APIKey is the key provided to you when your access request was accepted. Payload will contain a JSON object named ContactInfo. This object is a simple array containing EmailAddress or ContactID where ContactID is the internal ID used to track the customer in Lizzy.\n\n
The response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n\n Array\n (\n [0] => stdClass Object \n (\n [ContactID] => 1001\n [Points] => 2000\n [Credits] => 22.00\n )\n )\n
Use this method after you've called serializedunitinventory to keep up to date on the changes to the serialized inventory. This method provides you 2 different sections for newly received and updated units.
\nThis method is a GET request and requires two parameters \"APIKey\" and \"DateFrom\". The APIKey is the key provided to you when your access request was added. \"DateFrom\" is the starting date that you want to use for producing the list of serialized inventory and will return a list of \"Received\", \"Sold\" and \"Modified\" units (modified but not sold or received) since the provided date. So if you pass in 5 minutes ago it will send back all the units that have been received or modified in the last 5 minutes.
\n\nNOTE: There are three arrays of units returned in this call: To determine inventory changes first process the \"Received\" units list and then process the sold units to remove them from stock. The \"Modified\" units are just changes to existing units.
Afterwards make the call to serializedsales which contains a lot more detail if you are interested in that data.
\nThe \"DateFrom\" field supports both date and datetime values, the format is YYYY-MM-DD or YYYY-MM-DD HH:MI:SS.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n{\"Received\":[{\"Vendor\": \"EZGO\",\"UnitID\": \"155\",\"LastModifiedDate\": \"2019-04-26 20:16:42\",\"CompanyID\": \"605\",\"LocationID\": \"1\",\"UnitTypeID\": \"5\",\"VendorID\": \"348\",\"ModelNumber\": \"SPACE\",\"ModelName\": \"ROCKET JET SKI\",\"Price\": \"2500.00\",\"PromoDiscount\": \"88.00\",\"AccessoriesPrem\": \"0.00\",\"SetupPrem\": \"0.00\",\"SetupCost\": \"0.00\",\"RepairsCost\": \"0.00\",\"FlooringCost\": \"0.00\",\"FreightPrem\": \"0.00\",\"InstallationPrem\": \"0.00\",\"StockNo\": \"6668\",\"VIN\": \"FAKE5662666668\",\"UnitDescription\": \"\",\"ModelDescription\": \"HIGH PERFORMANCE JET SKI\",\"Length\": \"0ft0in\",\"Width\": \"0ft0in\",\"GVWLoaded\": \"0\",\"GVWEmpty\": \"0\",\"AxleCapacity\": \"0\",\"PullType\": null,\"ConstructionType\": null,\"EnclosureType\": null,\"TransModel\": \"\", \"NUDID\": \"Used\",\"Year\": \"2018\",\"CurrentOdometerHours\": \"0.00\",\"EngineHP\": \"0.00\",\"UnitImages\": [],\"ModelImages\": [{\"URL\": \"https://lizzy2.nizex.com/fs/webstore/605/59fc6e1ceb9e5979ba15fddb\", \"ImageType\": \"L\"}],\"Videos\": [],\"Assembled\": \"0\",\"AccessoriesCost\": \"0.00\",\"InstallationCost\": \"0.00\", \"FreightCost\": \"0.00\",\"Cost\": \"2440.00\",\"CurrentlyOnDealID\": \"11088\",\"Rebates\": [], \"WarrantyForever\": \"0\",\"UnitOptions\":[]},...], \"Sold\":[{\"Vendor\":\"BMW\",\"UnitID\":\"94\",\"LastModifiedDate\":\"2025-01-31 06:41:11\",\"CompanyID\":\"605\",\"LocationID\":\"1\",\"UnitTypeID\":\"61\",\"VendorID\":\"86\",\"ModelNumber\":\"000011\",\"ModelName\":\"5-SERIES SPORT PACKAGE\",\"Price\":\"0.00\",\"PromoDiscount\":\"0.00\",\"StockNo\":\"0015\",\"RepairsCost\":\"0.00\",\"FlooringCost\":\"0.00\",\"VIN\":\"00015\",\"UnitDescription\":\"\",\"ModelDescription\":\"5-SERIES SPORT PACKAGE I CHANGED THIS\",\"Length\":\"0ft0in\",\"Width\":\"0ft0in\",\"GVWLoaded\":\"0\",\"GVWEmpty\":\"0\",\"AxleCapacity\":\"0\",\"PullType\":null,\"ConstructionType\":null,\"EnclosureType\":null,\"TransModel\":\"\",\"NUDID\":\"New\",\"Year\":\"2015\",\"CurrentOdometerHours\":\"2.00\",\"EngineHP\":\"0.00\",\"UnitImageURL\":\"https://lizzy2.nizex.com/fs/webstore605/59f11fedeb9e5905d0071c5d\",\"ModelImageURL\":\"https://lizzy2.nizex.com/fs/webstore605/5d38af02987bca55216f4d73\"},\"WarrantyForever\":\"0\",...\\],\"Modified\":\\[{\"Vendor\":\"Walker\",\"UnitID\":\"14\",\"LastModifiedDate\":\"2025-03-05 20:24:50\",\"CompanyID\":\"605\",\"LocationID\":\"1\",\"RepairsCost\":\"0.00\",\"FlooringCost\":\"0.00\",\"UnitTypeID\":\"128\",\"VendorID\":\"9623\",\"ModelNumber\":\"MTGHS27I\",\"ModelName\":\"MODEL T\",\"Price\":\"15160.00\",\"PromoDiscount\":\"0.00\",\"StockNo\":\"1210\",\"VIN\":\"101210\",\"UnitDescription\":\"\",\"ModelDescription\":\"27-HP EFI KOHLER, 10.0\",\"Length\":\"0ft0in\",\"Width\":\"0ft0in\",\"GVWLoaded\":\"0\",\"GVWEmpty\":\"0\",\"AxleCapacity\":\"0\",\"PullType\":null,\"ConstructionType\":null,\"EnclosureType\":null,\"TransModel\":\"\",\"NUDID\":\"New\",\"Year\":\"2024\",\"CurrentOdometerHours\":\"0.00\",\"EngineHP\":\"0.00\",\"UnitImages\":[],\"ModelImages\":[],\"Videos\":[],\"Assembled\":null,\"AccessoriesCost\":\"0.00\",\"SetupCost\":\"0.00\",\"FreightCost\":\"0.00\",\"InstallationCost\":\"0.00\",\"Cost\":null,\"CurrentlyOnDealID\":\"24475\",\"Rebates\":[],\"WarrantyForever\":\"0\",\"UnitOptions\":[]},...]}
\n Array\n (\n [Received] (Array)\n [0] => (Object)\n (\n [Vendor] => Vendor/Brand Name\n [UnitID] => Internal ID for units in Lizzy \n [LastModifiedDate] => Date for last time unit's details were updated\n [CompanyID] => Internal ID for companies in Lizzy\n [LocationID] => Internal ID for locations in Lizzy\n [UnitTypeID] => Internal ID for unit types in Lizzy\n [VendorID] => Internal ID for vendors in Lizzy\n [ModelNumber] => Model Number assigned to unit\n [ModelName] => Model Name assigned to unit\n [Price] => Current asking price for unit\n [PromoDiscount] => Unit Discount in Dollar\n [StockNo] => Unit's stock number\n [VIN] => Unit's Serial/VIN number\n [ModelDescription] => Model description notes\n [UnitDescription] => Unit description notes\n [Length] => Length of unit in feet and inches\n [Width] => Width of unit in feet and inches\n [GVWLoaded] => Gross Vehicle Weight Loaded\n [GVWEmpty] => Gross Vehicle Weight Empty\n [AxleCapacity] => Max weight that can be supported by a single axle\n [PullType] => Trailer Type\n [ConstructionType] => Trailer Type\n [EnclosureType] => Trailer Type\n [TransModel] => Transmission Model Number\n [NUDID] => Unit's class (New=1,Pre-owned=2,Demo=3,Consignment=4)\n [Year] => Unit's model year\n [CurrentOdometerHours] => Number of hours logged on unit\n [EngineHP] => Engine's power rating\n [UnitImages] => (Array) Link/URL to get unit's photo if available\n [ModelImages] => (Array) Link/URL to get model's photo if available\n [Videos] => (Array) Link/URL to get Unit's Videos if available\n [AccessoriesCost] => Cost of Accessories attached to the unit\n [SetupCost] => Cost of Setup attached to the unit\n [RepairsCost] => Cost of repairs attached to the unit\n [FlooringCost] => Cost of Flooring\n [InstallationCost] => Cost of Installation attached to the unit\n [FreightCost] => Cost of Freight attached to the unit\n [CurrentlyOnDealID] => InvoiceID in Lizzy that the Unit is currently on\n [AccessoriesPrem] => Price of Accessories attached to the unit\n [SetupPrem] => Price of Setup attached to the unit\n [FreightPrem] => Price of Freight attached to the unit\n [InstallationPrem] => Price of Installation attached to the unit\n [Assembled] => 0 = not assembled, 1 = assembled\n [Cost] => 2399.00\n [CurrentlyOnDealID]. => Invoice ID in Lizzy\n [Rebates] => Array of Rebates \n [WarrantyForever] => Warranty Forever Flag\n [UnitOptions] => Array of Unit Factory Options including Name and Detail\n ),...\n [Sold] (Array)\n [0] => (Object)\n (\n Same as above\n ) \n [Modified] (Array)\n [0] => (Object)\n (\n Same as above\n )\n )\n\nUse this method to get a current list of serialized unit inventory at this very moment. You can call it any time you want all of the current units in stock but we recommend you combine it with calls to serializedunitdelta to get the changes to invenotry as it will be easier to keep up to date on what is going on after the intial call to this method.
\nThis method is a GET request and has four parameters: WebstoreID, DateFrom, LocationID and InclRentals. LocationID is used on the dealership side and will only be relevant if the dealership has more than one physical location. Default value is 1 and this field is not required. WebstoreID is sent through if you wish to have Lizzy limit the results based on a certain Webstore you’ve setup in Lizzy and is also not required. DateFrom, if passed in will tell it to only provide units that have been modified since the date provided. This enables you to retrieve a delta release of serialized items. It is sent through as “11/01/2017 12:00:00” to retrieve all units received or sold since that date and time. InclRentals is not required, but can be sent through with a value of 1 to include rental units in the results.
\nNote: InStock field below is only useful if doing a delta pull to show units that you may have received before but are no longer in stock and need to be pulled from the site
\n3)This uses the API key as a base64 encoded string sent through the header as Authorization: Basic APIKey.The API Key is generated in Lizzy and passed to the service making the api call.
\n Array\n (\n [0] => stdClass Object\n (\n [VendorName] => Name of Vendor in Lizzy\n [VIN] => Unique VIN or Serial number of units\n [UnitID] => Lizzy Internal ID. Only used if units are linked together.\n [NUDID] => Unit Status (\"New\", \"Used\", etc.) \n [Location] => Store Location Name\n [DealerCountry] => Country of Dealership (\"United States\")\n [StockNo] => Internal Stock Number of the unit\n [InStock] => Whether unit is instock or not 1= instock, 0 = sold \n [ParentUnitID] => Passed back if this unit is attached to something else. Ie: Boat and Trailer\n [ModelNumber] => Units Model Number\n [ModelName] => Secondary Model Number that also represents the unit\n [VehicleType] => Type of vehicle (Street, Dirt…)\n [UnitType] => N,U,D,R ( New, Used, Demo, Rental)\n [Year] => Manufactured Year\n [MSRP] => List Price for Unit\n [SalePrice] => Asking Price for the unit\n [PromoDiscount] => Discount applied to unit in dollars\n [Accessories] => Total for accessories added to unit\n [DateReceived] => Date Unit was Received by Dealer\n [AccessoriesCost] => The total cost for accessories added to unit\n [FlooringCost] => The cost of flooring added to unit\n [InstallationCost] => The total cost for installation added to unit\n [Videos] => (Array) Link/URL to get Unit's Videos if available\n [SetupCost] => Cost of Setup attached to the unit\n [FreightCost] => Cost of Freight attached to the unit\n [CurrentlyOnDealID] => InvoiceID in Lizzy that the Unit is currently on\n [AccessoriesPrice] => Price of Accessories attached to the unit\n [SetupPrice] => Price of Setup attached to the unit\n [FreightPrice] => Price of Freight attached to the unit\n [InstallationPrice] => Price of Installation attached to the unit\n [CurrentOdometer] => Current Odometer Reading\n [CurrentHours] => Current Hours on the Unit\n [ModelDescription] => Detailed description of unit model (generic description)\n [UnitDescription] => Detailed description of unit (specific to this unit)\n [UnitCondition] => Description of current condition of unit\n [Color] => Primary color of unit\n [FuelType] => Type of Fuel used in Engine(s)\n [EngineMake] => make of Engine(s)\n [EngineCCs] => size of Engine(s)\n [EngineHP] => Horsepower of Engine(s)\n [EngineCyls] => Number of cylinders for engines\n [LastModifiedDate] => Date of latest changes\n [Rebates] => (Array) List of rebates applied to unit\n [WarrantyForever] => Warranty Forever flag\n [UnitImages] \n [0]=> stdClass Object\n (\n [URL] => Location where unit image can be retrieved\n [ImageType] => \"T,S,M,L\" Thumbnail, Small, Medium, Large\n )\n [ModelImages] \n [0]=> stdClass Object\n (\n [URL] => Location where video unit image can be retrieved\n [ImageType] => \"T,S,M,L\" Thumbnail, Small, Medium, Large\n ) \n [DriveTrain] => Drive train in unit\n [Axles] => Number of axles on unit\n [EngineCompression] => Engine compression\n [EngineBoreStroke] => Engine Borestroke\n [ValvesPerCylinder] => Number of Valves per cylinder\n [FuelControl] => Fuel Control Information\n [Ignition] => Ignition System\n [CoolingSystem] => Cooling System\n [GearBox] => Gearbox information\n [TransType] => Transmission Type\n [TransModel] => Transmission Model\n [Cost] => Cost of unit\n [Assembled] => 0 = not assembled, 1 = assembled\n [UnitOptions] => (Array) Unit Factory Options\n (\n [Name] => Factory Option Name\n [Detail] => Factory Option Description\n )\n )\n )\n\nDealer specific key for access data
\n","type":"text"},{"key":"payload","value":"{\"begindate\":\"2023-01-01\",\"vinserial\":\"\",\"email\":\"\",\"phone\":\"\"}","description":"Required begindate, other fields optional. Call Uses email or phone but not both for locating a specific contact record
\n","type":"text"}],"url":"https://api.nizex.com/servicehistory","description":"This request receives parameters you'd like to use in order to get back a list of customers to send information to. It could also be used for Warranty recalls and such.
\n[\n {\n \"invnum\": \"265979\",\n \"businessname\": \"\",\n \"contactid\": \"747\"\n \"transactiondate\":\"2019-01-09 20:01:21\", \n \"customer\": [\n {\n \"firstname\": \"Janet\",\n \"lastname\": \"Deerman\",\n \"email\": \"motorsickle2@comcast.net\",\n \"phone\": \"615-869-9816\",\n \"phonetype\": \"Home\"\n }\n ],\n \"unitid\": \"6334\",\n \"vin\": \"56KTRAAA8G3334358\",\n \"typeofunit\": \"Motorcycle\",\n \"year\": \"2016\",\n \"make\": \"Indian\",\n \"modelnumber\": \"N16TRAAAAA\",\n \"modelname\": \"ROADMASTER\",\n \"jobs\": [\n {\n \"jobid\": \"50907\",\n \"jobtitle\": \"\\\\\\*REPLACE REAR SHOCK\",\n \"serviceperformed\": \"\",\n \"datecreated\": \"2018-09-28 20:16:28\",\n \"datecompleted\": \"2019-01-09 20:01:21\",\n \"datepickedup\": \"2019-01-09 20:04:19\",\n \"laborhours\": \"1.5000\",\n \"warranty\": \"0\",\n \"laborprice\": \"142.50\",\n \"laborcost\": \"57.53\",\n \"parts\": [\n {\n \"vendor\": \"Polaris\",\n \"partnumber\": \"1543839\",\n \"category\": \"Hard Parts - Polaris\",\n \"description\": \"SHOCK-TOUR\",\n \"list\":\"669.99\",\n \"cost\":\"502.49\",\n \"qty\": \"1.000\"\n }\n ]\n }\n ]\n }\n]\n\nDealer specific key for access data
\n","key":"Authorization","type":"text","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw"},{"description":"Required begindate, other fields optional. Call Uses email or phone but not both for locating a specific contact record
\n","key":"payload","type":"text","value":"{\"begindate\":\"2023-05-20\", \"enddate\":\"2023-06-20\",\"vinserial\":\"\",\"email\":\"\",\"phone\":\"\"}"}],"body":{"mode":"formdata","formdata":[{"key":"payload","value":"{\"begindate\":\"2019-05-20\",\"vinserial\":\"\",\"email\":\"\",\"phone\":\"\"}","type":"text"}]},"url":"https://api.nizex.com/serializedsales?payload={\"begindate\":\"2019-05-20\",\"enddate\":\"2023-06-20\",\"vinserial\":\"\",\"email\":\"\",\"phone\":\"\"}","description":"This request takes an apikey and payload. The payload has to contain a begin date to return all serialized sales since that date. It can also contain an end date, a VIN or customer phone or email in order to look at a specific item or customer. NOTE: unitid and contactid are internal id's for the respective items and not required to use. If stored they may be used in other calls to speed things along and that is the reason they are returned.
\n(If a unit falls under the Lawn & Garden or Power Equipment unit type categories, any battery or charger information entered into Lizzy will be given in the response in the \"extras\" object.)
\n[\n {\n \"invnum\": \"246725\",\n \"businessname\": \"\",\n \"contactid\": \"12345\",\n \"location\": \"In Store\",\n \"salesman\" : \"Billy Jonesey\",\n \"solddate\": \"2019-06-01\"\n \"wholesale\": \"0 = not wholesale, 1 = wholesale\"\n \"frontendprofit\":\"3232.22\",\n \"backendprofit\":\"2342.23\",\n \"address\": \"219 VAUGHNS GAP RD\",\n \"address2\": \"\",\n \"city\": \"NASHVILLE\",\n \"state\": \"TN\",\n \"zipcode\": \"37205\",\n \"customer\": [\n {\n \"firstname\": \"DAVID\",\n \"lastname\": \"CARTWRIGHT\",\n \"email\": null,\n \"phone\": \"615-618-4929\",\n \"phonetype\": \"Mobile\"\n }\n ],\n \"Units\": [\n {\n \"unitid\": null,\n \"vin\": \"VBKXWN230KM366746\",\n \"stocknum\" :\"66746\",\n \"year\": \"2019\",\n \"make\": \"KTM\",\n \"modelnumber\": \"300 XC-W TPI\",\n \"modelname\": \"300 XC-W TPI\",\n \"enginenumber\": \"\",\n \"saleprice\": \"5499.99\",\n \"purchasedate\":\"2019-01-01\",\n \"cost\":\"2399.99\",\n \"setup\":\"200\",\n \"deliverydate\":\"2019-01-01\",\n \"setupcost\":\"100\",\n \"freight\",\"250\",\n \"freightcost\",\"100\",\n \"accessories\",\"250\",\n \"accessoriescost\",\"125\",\n \"fleetsale\":\"0 = not fleet, 1 = is fleet\",\n \"typeofunit\": \"Motorcycle\",\n \"nudid\": \"New, Used, Demo, Consignment\",\n \"attachedaccessories\":[\n {\n \"itemnumber\": \"1000015\",\n \"mfg\":\"KTM\",\n \"cost\":\"10.50\",\n \"qty\":\"1.00000\"\n }\n ],\n \"extras\": []\n }\n ]\n }\n]\n\nDealer specific key for access data
\n","key":"apikey","type":"text","value":"486c447a-06e7-44bb-a6c7-2f218a9f31f6"},{"description":"Required begindate, other fields optional. Call Uses email or phone but not both for locating a specific contact record
\n","key":"payload","type":"text","value":"{\"begindate\":\"2024-01-01\",\"enddate\":\"2024-02-01\",\"email\":\"\",\"phone\":\"\"}"}],"url":"https://api.nizex.com/partsales","description":"This method takes an apikey and a payload. The payload is required to contain a date to begin and it returns all parts sales since that date. You can also pass in customer phone or email to return all part sales for a specific customer.
\n[\n {\n \"invnum\": \"280824\",\n \"businessname\": \"\",\n \"contactid\": \"37\",\n \"transactiondate\": \"2018-12-31 14:21:07\"\n \"address\": \"1630 Rodgers Rd\",\n \"address2\": \"\",\n \"city\": \"LEBANON\",\n \"state\": \"TN\",\n \"zipcode\": \"37087\",\n \"customer\": [\n {\n \"firstname\": \"Thomas\",\n \"lastname\": \"Baird\",\n \"email\": \"\",\n \"phone\": \"615-489-2626\",\n \"phonetype\": \"Mobile\"\n }\n ],\n \"completedby\": \"Sara Broughton\",\n \"parts\": [\n {\n \"vendor\": \"Kawasaki\",\n \"partnumber\": \"59011-0003\",\n \"description\": \"Belt\",\n \"category\": \"Hard Parts\",\n \"qty\": \"1.000\",\n \"list\": 86.60,\n \"cost\": 68.21\n }\n ]\n }\n]\n\nThis method is a POST request and requires one parameter [payload] which is a JSON object. There are 3 forms on the mylizzy.com website. 1. Contact for sales/support 2. Contact for demo 3. Contact for free trial. A single flag coming over within payload will tell us what we are looking for and need in the mylizzy_contact.php. Unlike other places, we are not inside of Lizzy or logged in and this is specific to Nizex customers.
\n\nThe response will return an HTTP status code and the body will contain the response text. If an error has occurred, the response text will be an error message.
\n\nThis method is a POST request and requires two parameters APIKey and Payload. The APIKey is the key provided to you when your access request was accepted and will be passed through the API in the HEADER as a base64encoded string. Payload will contain a JSON object named Orders, this object is an array containing the purchase order objects that you want to submit to Lizzy. WebstoreID is an optional field supplied by the business you're sending orders into and can be found in Settings → Webstore → Setup Webstore Interfaces. It is supplied as an Integer and is required in order for Lizzy to hook the incoming order to a specific interface with the Lizzy BMS System. If the order your placing into does not provide a number then simply pass an 11 into the call.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, if successful there is no response text. See appendix A for HTTP status codes.
\n\n\n stdClass Object \n (\n [Orders] => Array\n (\n [0] => stdClass Object\n (\n [OrderNumber] => 825713\n [Date] => 2013-02-12\n [Time] => 15:28\n [InvoiceNumber] => 12123\n [Tax] => 1.99\n [SalesmanID] => SalesPersonid from Lizzy that gets credit for sale if available.\n [ShippingCost] => 5.99 \n [CheckName] => 0 false, 1=true Verify finding record in Lizzy to include first and last name. (only applies to Amazon import interface)\n [Total] => 28.83\n [Notes] => Special notes for order\n \n\n","urlObject":{"protocol":"https","path":["submitorder"],"host":["api","nizex","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b25b3dd2-f184-2885-dfac-bfc55db28715"},{"name":"scale","id":"d3b39105-b702-13c4-1172-412e6f031624","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.nizex.com/scale?apikey=adfadfasdfa&hostname=computer1&weight=1.2","description":"[Customer]=> stdClass Object\n (\n [FirstName] => John\n [LastName] => Smith\n [EmailAddress] => jsmith@somecompany.com\n [CompanyName] => Some Company\n [Phone] => 6783594184\n [Address] => 1735 Pennsylvania Ave.\n [Address2] => \n [City] => McDonough\n [State] => GA\n [ZipCode] => 30353\n [Country] => US\n )\n\n [ShippingAddress]=> stdClass Object\n (\n [FirstName] => John\n [LastName] => Smith\n [CompanyName] => Some Company\n [Phone] => 6783594184\n [Address] => 1735 Pennsylvania Ave.\n [Address2] =>\n [City] => McDonough\n [State] => GA\n [ZipCode] => 30353\n [Country] => US\n [Method] => Priority Mail\n )\n\n [BillingAddress]=> stdClass Object \n (\n [FirstName] => John\n [LastName] => Smith\n [EmailAddress] => jsmith@somecompany.com (used only if missing from customer)\n [CompanyName] => Some Company\n [Phone] => 6783594184\n [Address] => 1735 Pennsylvania Ave.\n [Address2] =>\n [City] => McDonough\n [State] => GA\n [ZipCode] => 30353\n [Country] => US\n )\n \n [OrderItems]=> Array\n (\n [0] => stdClass Object\n (\n [ProductID] => 01-0013\n [ProductCode] => PUN\n [ProductDesc] => Oil Filter, Kawasaki\n [SupplierSKU] => Part number of supplier\n [Supplier] => Who we actually want to purchase from\n [Price] => 6.95\n [Quantity] => 2\n [VehYear] => year of model it is being order for (not required)\n [VehMake] => make of model it is being order for (not required)\n [VehModel] => Model number it is being order for (not required)\n [VehType] => Vehicle Type to classify model (not required)\n [DropShip] => Drop ship items to customer\n )\n )\n )\n )\n)\n
This method is a POST request and requires three parameters APIKey, hostname and weight. The APIKey is the key provided to you when your access request was accepted. Hostname is the name of the computer the scale is attached to and is retreived each time a call is made to the Lizzy BMS system. Weight is the scales current package weight being messured. A call will result in Lizzy updating the computers weight table that is retrieved for the user during the shipping process. A simple 200 HTTP response will be receieved after making the call.
\n\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, if successful there is no response text. See appendix A for HTTP status codes.
\n\nThis method is for internal use only.
\n","urlObject":{"protocol":"https","path":["pricefile"],"host":["api","nizex","com"],"query":[{"key":"APIKey","value":"sampleAPIKey"}],"variable":[]}},"response":[],"_postman_id":"74f845a6-5a90-0bd1-aa44-4aac2ef641e9"},{"name":"submitcrmlead","id":"aa7ba73e-0590-0718-c6b0-1b5cdbe8be27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"URL Encoded API Key
\n","key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"LeadInterface","type":"text","value":"Polaris"},{"key":"payload","type":"text","value":"{\"contact\":{\"firstname\":\"JUS\",\"lastname\":\"Bussin\",\"emailaddress\":\"tb12goat@tst12l.com\",\"companyname\":\"Prestige World Wide\",\"comments\":\"THIS BE A TEST\",\"phone\":{\"home\":\"6149851234\",\"mobile\":\"6186787001\",\"work\":\"6184566969\"},\"address\":\"1776 Freedom Way\",\"address2\":\"7-10 MF SB Lane\",\"state\":\"GA\",\"zipcode\":\"30252\",\"country\":\"US\",\"city\":\"McDonough\"},\"leadinfo\":{\"leadtype\":\"Request Brochure\",\"leadcategory\":\"URL String\",\"purchasetimeframe\":\"2 Days\"},\"unit\":{\"vin\":\"151654546548511\",\"model\":\"-230P\",\"make\":\"Honda\",\"interest\":\"buy\",\"year\":\"2000\",\"stocknum\":\"006102\",\"condition\":\"New\",\"color\":\"RED\"}}"},{"key":"type","value":"JSON","type":"text"}]},"url":"https://api.nizex.com/submitcrmlead","description":"This method is a POST request and requires three parameters, Authorization,payload and type.The call can handle either a JSON Array or ADF XML.
\nThe Authorization is the APIKey provided to you by the dealership when your access request was accepted. The Authorization key will be passed in through the header as a base64encoded() string.
\n\nleadinterface is where the lead comes from.
\n\npayload is the form element that will contain your details of the call.\nThe payload will either contain a JSON Array or will contain an ADF XML.
\n\ntype is a form element that will contain what the data is presented as, accepted values are 'ADF' and 'JSON'.
\n\nThe Phone element is an array that can handle, Home,Work and Mobile. If \nyou do not put Phone as an array and just pass in an element, then we will\nmark it as Home.
\n\nThe response will return an HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, if successful there will be a tracking id field returned that will reference the contact in Lizzy that the lead was established for. See appendix A for HTTP status codes.
\n\nThe below information shows the JSON fields that can be sent through and an asterisk denotes the required fields. Also note that it is a multidimensional array with contact, insurance and unit being the top most elements.
\n\n contact\n leadid This field can be passed in to aid in passing lead status updates back to vendor\n *firstname\n *lastname\n *emailaddress Email or phone must be supplied to be valid\n companyname\n *phone Email or phone must be supplied to be valid\n Home:\n Mobile:\n Work: \n address\n address2\n state\n comments\n zipcode\n country\n city\n dlnumber drivers license number\n dlissuedate 2018-03-01\n dlexpdate 2019-01-01\n dob 1990-01-01\n ssn social security number\n dateinhouse 2019-02-27 09:00 (If customer wants to schedule appointment to come in) Dealership timezone\n datetocall 2019-02-27 10:00 (If customer would like a call on specific date and time) Dealership timezone\n insurance\n company \n agentname\n phonenumber\n fax\n address\n emailaddress\n policynum\n effectivedate 2018-01-01\n expdate 2019-01-01\n comprehensivedeductable\n collisiondeductable\n firetheft\n dateverified 2018-01-01\n verifiedwith\n verifiedby\nleadinfo \n leadtype - ie:Request Brochure\n leadcategory - This would hold a URL\n purchasetimeframe - This would hold a date range\n\n\nunit:\n vin\n model\n make\n year\n interest values: buy , trade-in , tells lizzy what type of unit \n stockno Provided by dealer if inventory is uploaded daily\n condition New, Used, Demo, Rental \n color - color of unit\n
This method is a GET request and requires the following parameter: APIKey.Page and Lastmodified are optional fields. The APIKey is the key provided to you when your access request was accepted and is passed in the header as a base64encoded() variable.
\nPage will be sent back if the call returns more than 100 results. If no page is sent back, then there are less than 100 results. To get the next page of resutls, just take the page variable returned and pass it in as a param.
\nThe Lastmodified field is going to return results that have a last modified date of the date passed in or later.
\nNote: Lastmodified expected to be in format of Year-Month-Date. ie: 2018-03-14
\nThe response will return a HTTP status code and the body will contain response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\nPossible HTTP Return Codes:
\n{\n \"ContactID\": \"12\",\n \"FirstName\": \"Test\",\n \"LastName\": \"Contact\",\n \"Phone\": \"800.555.6633\",\n \"EmailAddress\": \"\",\n \"Address\": \"p.o. box 111\",\n \"City\": \"YOUNGSTOWN\",\n \"State\": \"\",\n \"ZipCode\": \"44512\",\n \"DateLastModified\": \"2021-06-01\"
\n","urlObject":{"protocol":"https","path":["rest","api","contactlist"],"host":["api","nizex","com"],"query":[{"disabled":true,"key":"lastmodified","value":"2021-06-01"},{"disabled":true,"key":"page","value":"2"}],"variable":[]}},"response":[],"_postman_id":"ae7ca8d2-eb95-4bf1-a06b-e7414831fdba"},{"name":"https://api.nizex.com/contactlist","id":"49356ac4-fda9-4512-af36-bda5578a36bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"lastmodified","value":"2021-08-01","type":"text","disabled":true}]},"url":"https://api.nizex.com/contactlist","description":"This call will get a list of contacts that have been modified since the last time this was called. If it is the first time calling this API, you will get the last 6 months of changes and then from that point you will get all changes to contacts since the last call.
\nThis API requires a Base64Encoded() APIKey passed through the header as Authorization : Basic APIKey .
\nThere is an optional reset flag that can be passed in that will bypass the date of last call and give you the last 2 years again. just pass it through as reset = 1.
\n","urlObject":{"protocol":"https","path":["contactlist"],"host":["api","nizex","com"],"query":[{"disabled":true,"key":"reset","value":"1"}],"variable":[]}},"response":[],"_postman_id":"49356ac4-fda9-4512-af36-bda5578a36bb"},{"name":"Get Chart of Accounts","id":"cac5dafe-a3fc-413b-9705-09daa8bbb3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://rusten.nizex.com/rest/api/getcoa","urlObject":{"protocol":"https","path":["rest","api","getcoa"],"host":["rusten","nizex","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"cac5dafe-a3fc-413b-9705-09daa8bbb3d9"},{"name":"Get Account Balances","id":"9febda80-e1dc-4049-968c-74b85161ee79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://rusten.nizex.com/rest/api/getendofmonth?Date=2022-05-20","description":"This API call will give you the Last 3 years of account historical data broken out by month and year if you do not pass through a months back that you would like to go.
\nThe monthback field will give you whatever number of months back that you provide from the current date.
\nThe locationid field will limit the results by whatever location you are trying to use. You can call the getlocationinfo api to get a list of the LocationIDs that you can use for this.
\nThe Authorization key has to be base64encoded() and passed in through the header as Authorization : Basic KEY
\n","urlObject":{"protocol":"https","path":["rest","api","getendofmonth"],"host":["rusten","nizex","com"],"query":[{"key":"Date","value":"2022-05-20"}],"variable":[]}},"response":[],"_postman_id":"9febda80-e1dc-4049-968c-74b85161ee79"},{"name":"Get Location Info","id":"e5dc217b-dc79-4ed0-a818-46ffb2e3924f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"This API is a GET call to retrieve the LocationID and Location Name for any given dealership.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e5dc217b-dc79-4ed0-a818-46ffb2e3924f"},{"name":"musdealdata","id":"a1a60b51-6ee2-4f9c-aaa2-6a1713601021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"4e53657f-5700-4052-8656-da3e2eb954d5","type":"text"},{"key":"payload","value":"{\"invoiceno\":\"27445\"}","type":"text"}],"url":"https://api.nizex.com/musdealdata","description":"This API is a GET call to retrieve all data pertaining to a Major Unit Sale/Quote Invoice. It requires an APIKey and an optional InvoiceNo. The APIKey is the key provided to you when your access request was added. The InvoiceNo is the invoice number of the invoice you are requesting data for. If the payload does not include an invoice number, the results will include all open major unit sales invoices.
\n","urlObject":{"protocol":"https","path":["musdealdata"],"host":["api","nizex","com"],"query":[],"variable":[]}},"response":[{"id":"ce8c7d40-1b14-4a11-8220-21959262a955","name":"musdealdata","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"4e53657f-5700-4052-8656-da3e2eb954d5","type":"text"},{"key":"payload","value":"{\"invoiceno\":\"27445\"}","type":"text"}],"url":"https://api.nizex.com/musdealdata"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 17 Jan 2025 14:03:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3926"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"InvoiceNumber\": \"27445\",\n \"dlrInfo\": {\n \"Name\": \"Lizzy OPE and Motorsports\",\n \"Address\": \"126A Singley Road\",\n \"City\": \"CINCINNATI\",\n \"County\": \"HAMILTON\",\n \"State\": \"OH\",\n \"ZipCode\": \"45201\",\n \"Phone\": \"(678) 374-3441\",\n \"Fax\": null,\n \"EmailAddress\": \"sales@nizex.com\"\n },\n \"byrInfo\": {\n \"FirstName\": \"Tumbleweed\",\n \"LastName\": \"Rogers\",\n \"MiddleInitial\": \"E\",\n \"Address\": \"156 Nells Knob Cove\",\n \"City\": \"BATH SPRINGS\",\n \"County\": \"DECATUR\",\n \"State\": \"TN\",\n \"ZipCode\": \"38311\",\n \"MailAddress\": \"PO Box 000\",\n \"MailCity\": \"DECATURVILLE\",\n \"MailCounty\": \"DECATUR\",\n \"MailState\": \"TN\",\n \"MailZipCode\": \"38329\",\n \"HomePhone\": \"(503) 666-2416\",\n \"WorkPhone\": \"(800) 333-9785\",\n \"CellPhone\": null,\n \"DrLicNo\": \"2799029\",\n \"DrLicState\": \"OR\",\n \"EmailAddress\": \"Urkel930@gmail.com\"\n },\n \"cbyInfo\": {\n \"FirstName\": \"Nancy\",\n \"LastName\": \"Boxnuckler\",\n \"MiddleInitial\": \"C\",\n \"Address\": \"32477\",\n \"City\": \"COTTAGE GROVE\",\n \"County\": \"LANE\",\n \"State\": \"OR\",\n \"ZipCode\": \"97424\",\n \"MailAddress\": \"PO Box 0101\",\n \"MailCity\": \"ALBANY\",\n \"MailCounty\": \"LINN\",\n \"MailState\": \"OR\",\n \"MailZipCode\": \"97322\",\n \"HomePhone\": \"(541) 510-3632\",\n \"WorkPhone\": \"(503) 895-2245\",\n \"CellPhone\": \"(605) 423-9777\",\n \"DrLicNo\": \"OR22113\",\n \"DrLicState\": \"OR\",\n \"EmailAddress\": null\n },\n \"sldUnit\": {\n \"VIN\": \"USKAW6VEN0Z234567\",\n \"StockNumber\": \"4567\",\n \"Year\": \"2011\",\n \"Make\": \"Kawasaki\",\n \"ModelName\": \"1235\",\n \"ModelNumber\": \"1235\",\n \"BodyType\": \"Street Bike\",\n \"Color\": \"BLUE\",\n \"PlateNumber\": \"ABC123\",\n \"EngineYear\": \"\",\n \"EngineMake\": \"ENGMAKE\",\n \"EngineModel\": \"ENGMODEL\",\n \"EngineVIN\": \"ENGVIN\",\n \"EngineCCs\": \"1753\",\n \"EngineHP\": \"112\",\n \"EngineCylinders\": \"2\",\n \"LengthFt\": \"8\",\n \"LengthIn\": \"6\",\n \"Axles\": \"2\",\n \"GVWEmpty\": \"850\",\n \"GVWLoaded\": \"1250\",\n \"DeliveryDate\": \"01-17-2025\",\n \"Status\": \"New\",\n \"Odometer\": \"13\",\n \"OdometerStatus\": \"Actual\",\n \"FuelType\": \"Gas\"\n },\n \"trdUnit\": {\n \"VIN\": \"INDIANHARLEYCROSS\",\n \"StockNo\": \"YCROSS\",\n \"Year\": \"2017\",\n \"Make\": \"Indian\",\n \"ModelName\": \"FAT BOY\",\n \"ModelNumber\": \"FLHTC\",\n \"BodyType\": \"Street Bike\",\n \"Color\": \"INDIAN RED\",\n \"PlateNumber\": \"INDSUKS\",\n \"EngineVIN\": \"POLARISENG1\",\n \"EngineCCs\": \"1844\",\n \"Odometer\": \"49025\",\n \"OdometerStatus\": \"Actual\",\n \"PayoffName\": \"American Honda\",\n \"PayoffAddress\": \"1234 Somewhere ddrive\",\n \"PayoffCity\": \"STRUTHERS\",\n \"PayoffState\": \"OH\",\n \"PayoffZipCode\": \"44471\",\n \"PayoffPhone\": \"888.888.8888\"\n },\n \"dealInfo\": {\n \"Price\": \"7999.00\",\n \"Freight\": \"450.00\",\n \"Setup\": \"250.00\",\n \"PDI\": \"85.00\",\n \"Shipping\": \"0.00\",\n \"Accessories\": \"2200.00\",\n \"AccessoriesInstallation\": \"350.00\",\n \"GAPPrem\": \"100.00\",\n \"ESPPrem\": \"300.00\",\n \"PrePdMaintPrem\": \"400.00\",\n \"TireWheelPrem\": \"500.00\",\n \"AlarmPrem\": 0,\n \"TheftProtPrep\": 700,\n \"LoJackPrem\": 0,\n \"BatProtPrem\": \"600.00\",\n \"BatTenderPrem\": \"1000.00\",\n \"PaintProtPrem\": 0,\n \"IntProtPrem\": 0,\n \"UnderCoatPrem\": 0,\n \"ChemPkgPrem\": \"900.00\",\n \"PropertyInsPrem\": \"0.00\",\n \"KeyReplacementPrem\": \"800.00\",\n \"Repairs\": \"100.00\",\n \"TariffTax\": \"345.00\",\n \"CommoditySurcharge\": \"650.00\",\n \"AdminFees\": \"860.00\",\n \"DOCFee\": \"300.00\",\n \"AdminComputerFee\": \"150.00\",\n \"ArbitrationFee\": \"50.00\",\n \"NotaryFee\": \"25.00\",\n \"MailFee\": \"10.00\",\n \"MessengerServiceFee\": \"75.00\",\n \"DeliveryFee\": \"250.00\",\n \"OfficialFees\": \"1385.00\",\n \"TitleFee\": \"25.00\",\n \"LicRegFee\": \"35.00\",\n \"ElectronicRegFee\": \"35.00\",\n \"TempTagFee\": \"105.00\",\n \"InspectionFee\": \"135.00\",\n \"CoastGuardFee\": \"15.00\",\n \"CountyFee\": \"40.00\",\n \"StateLienFee\": \"30.00\",\n \"TireDisposalFee\": \"85.00\",\n \"BatteryDisposalFee\": \"80.00\",\n \"TransferFee\": \"45.00\",\n \"TransitFee\": \"75.00\",\n \"FuelOilFee\": \"120.00\",\n \"RoadBridgeFee\": \"95.00\",\n \"TruamaFee\": \"100.00\",\n \"HighAltitudeFee\": \"90.00\",\n \"DEQFee\": \"105.00\",\n \"OffRdParksRecFee\": \"60.00\",\n \"RegistrationTax\": null,\n \"StateDeputyFilingFee\": null,\n \"UnitPropertyTax\": \"110.00\",\n \"UCCFee\": null,\n \"BankLienFee\": null,\n \"BankFees\": \"0.00\",\n \"LoanFee\": null,\n \"MembershipFee\": null,\n \"VSIFee\": \"0.00\",\n \"SalesTax\": \"504.53\",\n \"Rebates\": \"0.00\",\n \"CashDown\": \"0.00\",\n \"TradeAllowance\": \"9500.00\",\n \"Payoff\": \"2408.39\",\n \"NetTrade\": 7091.610000000001\n },\n \"financeInfo\": {\n \"BankName\": \"Freedom Road\",\n \"BankAddress\": \"Address 123 Lame\",\n \"BankCity\": \"CORTLAND\",\n \"BankState\": \"OH\",\n \"BankZipCode\": \"44410\",\n \"BankPhone\": \"(330) 512-9656\",\n \"LienDate\": \"01-17-2025\",\n \"APR\": \"19.99\",\n \"Term\": \"72\",\n \"DaysToFirst\": 30,\n \"AmtFinanced\": \"13586.92\",\n \"MonthlyPmt\": \"325.36\",\n \"FinanceChrg\": 9839.000000000002,\n \"TtlOfPmts\": 23425.920000000002,\n \"TtlSalePrice\": \"30517.53\"\n }\n}"}],"_postman_id":"a1a60b51-6ee2-4f9c-aaa2-6a1713601021"},{"name":"getorders","id":"79a3eb1f-134f-472e-a73f-3a7758f4f523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ZjYyNzc0NjItOWJkMS00OTVmLTljMGItNzNiOTdjMGFlZDYw","description":"Base64 Enccoded API Key
\n","type":"text"}],"url":"https://api.nizex.com/getorders?payload={\"begindate\":\"2025-09-01\",\"enddate\":\"2025-10-01\"}","description":"This method is a GET request and requires two parameters APIKey and Payload which contains a JSON object with a Begin Date and End Date to lookup invoices. The APIKey is the key provided to you when your access request was accepted.The APIKey will be passed in the header as a base64encoded() element.
\n\nThe response will return an HTTP status code and the body will contain the response text. If an error has occurred, the response text will be an error message, otherwise it will contain a JSON Array with the requested data.
\n\n[
\n{
\"InvoiceDate\": \"2021-06-08 18:07:51\",
\"ContactID\": \"98911\",
\"ShippingAmount\": \"0.00\",
\"ShipVia\": null,
\"Tax\": \"0.00\",
\"Total\": \"500.00\",
\"BusinessName\": \"titan\",
\"FirstName\": \"Astrid\",
\"LastName\": \"Beaowulf\",
\"EmailAddress\": \"testemail@testemail.com\",
\"Phone\": \"330-333-0023\",
\"Address\": \"001 Somwhere Ave\",
\"Address2\": \"\",
\"City\": \"HUBBARD\",
\"State\": \"Ohio\",
\"Zipcode\": \"44425\",
\"Country\": \"UNITED STATES\",
\"Parts\": [
{
\"VendorName\": \"Cyberdine Systems\",
\"ItemNumber\": \"000M999\",
\"Description\": \"Armat M999 Headlamp\",
\"Qty\": \"1.00000\",
\"ExtPrice\": \"500.00\"
},
{
\"VendorName\": \"Cyberdine Systems\",
\"ItemNumber\": \"000MTEST007\",
\"Description\": \"Test007\",
\"Qty\": \"1.00000\",
\"ExtPrice\": \"250.00\"
}
]
},
{....}
\n]
\nArray(\n Array\n (\n [0] => stdClass Object\n (\n [ContactID] => 3 (Lizzy's Internal ContactID)\n [BusinessName] => Some Company\n [FirstName] => John\n [LastName] => Smith\n [EmailAddress] => jsmith@somecompany.com\n [Phone] => 7705154546\n [Address] => 123 45th St.\n [Address2] => \n [City] => Atlanta\n [State] => Georgia\n [Zipcode] => 30332\n [Country] => United States\n [InvoiceDate] => 2013-01-22 12:09:22\n [ShippingAmount => 10.95\n [ShipVia] => UPS\n [Tax] => 0\n [Total] => 22.01\n [Parts]\n [0] => stdClass Object\n (\n [VendorName] => Honda\n [ItemNumber] => 12345\n [Description] => Generator\n [Qty] => 1\n [ExtPrice] => 12.95\n )\n )\n ...\n )\n)\n\nDate range to pull invoice data
\n","type":"text/plain"},"key":"payload","value":"{\"begindate\":\"2025-09-01\",\"enddate\":\"2025-10-01\"}"}],"variable":[]}},"response":[],"_postman_id":"79a3eb1f-134f-472e-a73f-3a7758f4f523"}]}