\r\n Lipsey's offers Software as a Service integrations through our{\" \"}\r\n \r\n Preferred Partners\r\n \r\n
\r\n\r\n Integrating through one of our partners is ideal for dealers looking for pre-built software with dedicated support. {\" \"}\r\n Integrations with our partners are automatically approved {\" \"}\r\n and do not require filling out the form.\r\n\r\n
\r\n\r\n To access Lipsey's API you first need to have your Domains And IP Addresses Pre-Approved requests can be made.
\r\n Please{\" \"}\r\n
\r\n Most requests require authorization, and requests that do not may return information unique to a dealer when authorized.
\r\n To make an authorized request, a login request must be made and the token returned with the login response\r\n will be used for all requests to be authorized.\r\n
See for details on login and obtaining an authorization token.
\r\nMost Requests made to Lipsey's API is made through POST HTTP Requests. Every request made returns a base data set that includes a data field.
\r\n\r\n\r\nSuccess represents if the request was successful.
\r\n\r\n Authorized \r\n represents that the request made had an authorization token, and that that token was valid.
\r\n Depending on the request, a request is not required to be authorized in order to be successful.\r\n
Errors is an array of strings containing the error messages if a request was either partially or completely unsuccessful.
\r\nData is the object that will contain the information requested.
\r\n\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": Object
\r\n {'}'}\r\n \r\n \r\n Any Item Number Input Fields can be a Lipsey's Item Number, a Manufacturer Model Number, or a UPC
\r\nExample: For THIS item we would accept \"RULCP\", \"3701\", or \"736676037018\"
\r\n\r\n\r\n\r\nWorking in C#, VB, NodeJs, or in PHP? We have packages available for easy integration!
\r\n \r\n\r\nPostman is a tool to test APIs, share request examples, and generate code for requests.
\r\n\r\n To test the API endpoints in Postman, first, download and install the Postman desktop application using the link below. \r\n After Postman is installed, click the 'Run in Postman' button and import a copy of the collection. \r\n
\r\n\r\n \r\n Download Postman\r\n \r\n
\r\n\r\n
\r\n The Postman collection must be run using the Postman desktop application on a computer with a whitelisted IP address.\r\n Testing the API endpoints using the Postman website or a computer without a whitelisted IP address will always generate a 'Not Authorized' response. \r\n
\r\nAPI is rate limited, each endpoint may have a unique rate limit,\r\n which is described in these docs on each request.
\r\nAbuse of the API may result in revoked access which can be appealed by contacting us.
\r\nPOST - Validates item for ordering
\r\nUSE CASE - The Lipsey's Catalog is consumed every few hours and the quantity of items changes regularly.\r\n Using ValidateItem during a website's checkout process can provide a more accurate quantity and help prevent partially filled orders.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n String (Item Number - Required)
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"qty\": Int,
\r\n \"price\": Double,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"itemNumber\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/ValidateItem',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n Content-Type: 'application/json'
\r\n {'}'},
\r\n body: [ItemNumber]
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Pricing Quantity Feed - Get Catalog pricing and quantity based on logged in account. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\nPricing And Quantity Feed will not update more than once per hour, repeated requests will return cached results.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\nNone
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"nextUpdate\": DateTime,
\r\n \"items\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"upc\": String,
\r\n \"mfgModelNumber\": String,
\r\n \"quantity\": Int,
\r\n \"allocated\": bool,
\r\n \"onSale\": bool,
\r\n \"price\": decimal,
\r\n \"currentPrice\": decimal,
\r\n \"retailMap\": decimal
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'GET',
\r\n url: '{url}/PricingQuantityFeed',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'}
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Catalog Feed - Get Catalog details based on logged in account. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\nCatalog feed will not update more then once per four hours, repeated requests will return cached results.
\r\n\r\n Images are available using the imageName fixed onto our image server url: https://www.lipseyscloud.com/images/[image name]
\r\n Example: https://www.lipseyscloud.com/images/siw22045sp.jpg
\r\n Please do not hotlink our images. Download them to your own hosting solution before use.\r\n
Bound book information is not intended to use without checking the firearms you receive, Lipsey's is not responsible for the correctness of dealer bound books.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\nNone
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"itemNo\": String,
\r\n \"description1\": String,
\r\n \"description2\": String,
\r\n \"upc\": String,
\r\n \"manufacturerModelNo\": String,
\r\n \"msrp\": Double,
\r\n \"model\": String,
\r\n \"caliberGauge\": String,
\r\n \"manufacturer\": String,
\r\n \"type\": String,
\r\n \"action\": String,
\r\n \"barrelLength\": String,
\r\n \"capacity\": String,
\r\n \"finish\": String,
\r\n \"overallLength\": String,
\r\n \"receiver\": String,
\r\n \"safety\": String,
\r\n \"sights\": String,
\r\n \"stockFrameGrips\": String,
\r\n \"magazine\": String,
\r\n \"weight\": String,
\r\n \"imageName\": String,
\r\n \"chamber\": String,
\r\n \"drilledAndTapped\": Bool,
\r\n \"rateOfTwist\": String,
\r\n \"itemType\": String,
\r\n \"additionalFeature1\": String,
\r\n \"additionalFeature2\": String,
\r\n \"additionalFeature3\": String,
\r\n \"shippingWeight\": Double,
\r\n \"boundBookManufacturer\": String,
\r\n \"boundBookModel\": String,
\r\n \"boundBookType\": String,
\r\n \"nfaThreadPattern\": String,
\r\n \"nfaAttachmentMethod\": String,
\r\n \"nfaBaffleType\": String,
\r\n \"silencerCanBeDisassembled\": Bool,
\r\n \"silencerConstructionMaterial\": String,
\r\n \"nfaDbReduction\": String,
\r\n \"silencerOutsideDiameter\": String,
\r\n \"nfaForm3Caliber\": String,
\r\n \"opticMagnification\": String,
\r\n \"maintubeSize\": String,
\r\n \"adjustableObjective\": Bool,
\r\n \"objectiveSize\": String,
\r\n \"opticAdjustments\": String,
\r\n \"illuminatedReticle\": Bool,
\r\n \"reticle\": String,
\r\n \"exclusive\": Bool,
\r\n \"quantity\": Int,
\r\n \"allocated\": Bool,
\r\n \"onSale\": Bool,
\r\n \"price\": Double,
\r\n \"currentPrice\": Double,
\r\n \"retailMap\": Double,
\r\n \"fflRequired\": Bool,
\r\n \"sotRequired\": Bool,
\r\n \"scopeCoverIncluded\": Bool,
\r\n \"special\": String,
\r\n \"sightsType\": String,
\r\n \"case\": String,
\r\n \"choke\": String,
\r\n \"dbReduction\": String,
\r\n \"family\": String,
\r\n \"finishType\": String,
\r\n \"frame\": String,
\r\n \"gripType\": String,
\r\n \"handgunSlideMaterial\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'GET',
\r\n url: '{url}/CatalogFeed',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'}
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Catalog Feed Item - Get Catalog details for one item based on logged in account. Item number parameter can be a Lipsey's Item Number, a UPC or a Manufacturer Model Number. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\n\r\n Images are available using the imageName fixed onto our image server url: https://www.lipseyscloud.com/images/[image name]
\r\n Example: https://www.lipseyscloud.com/images/siw22045sp.jpg\r\n
Bound book information is not intended to use without checking the firearms you receive, Lipsey's is not responsible for the correctness of dealer bound books.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n String (Required, Item Number)
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"itemNo\": String,
\r\n \"description1\": String,
\r\n \"description2\": String,
\r\n \"upc\": String,
\r\n \"manufacturerModelNo\": String,
\r\n \"msrp\": Double,
\r\n \"model\": String,
\r\n \"caliberGauge\": String,
\r\n \"manufacturer\": String,
\r\n \"type\": String,
\r\n \"action\": String,
\r\n \"barrelLength\": String,
\r\n \"capacity\": String,
\r\n \"finish\": String,
\r\n \"overallLength\": String,
\r\n \"receiver\": String,
\r\n \"safety\": String,
\r\n \"sights\": String,
\r\n \"stockFrameGrips\": String,
\r\n \"magazine\": String,
\r\n \"weight\": String,
\r\n \"imageName\": String,
\r\n \"chamber\": String,
\r\n \"drilledAndTapped\": Bool,
\r\n \"rateOfTwist\": String,
\r\n \"itemType\": String,
\r\n \"additionalFeature1\": String,
\r\n \"additionalFeature2\": String,
\r\n \"additionalFeature3\": String,
\r\n \"shippingWeight\": Double,
\r\n \"boundBookManufacturer\": String,
\r\n \"boundBookModel\": String,
\r\n \"boundBookType\": String,
\r\n \"nfaThreadPattern\": String,
\r\n \"nfaAttachmentMethod\": String,
\r\n \"nfaBaffleType\": String,
\r\n \"silencerCanBeDisassembled\": Bool,
\r\n \"silencerConstructionMaterial\": String,
\r\n \"nfaDbReduction\": String,
\r\n \"silencerOutsideDiameter\": String,
\r\n \"nfaForm3Caliber\": String,
\r\n \"opticMagnification\": String,
\r\n \"maintubeSize\": String,
\r\n \"adjustableObjective\": Bool,
\r\n \"objectiveSize\": String,
\r\n \"opticAdjustments\": String,
\r\n \"illuminatedReticle\": Bool,
\r\n \"reticle\": String,
\r\n \"exclusive\": Bool,
\r\n \"quantity\": Int,
\r\n \"allocated\": Bool,
\r\n \"onSale\": Bool,
\r\n \"price\": Double,
\r\n \"currentPrice\": Double,
\r\n \"retailMap\": Double,
\r\n \"fflRequired\": Bool,
\r\n \"sotRequired\": Bool
\r\n \"scopeCoverIncluded\": Bool,
\r\n \"special\": String,
\r\n \"sightsType\": String,
\r\n \"case\": String,
\r\n \"choke\": String,
\r\n \"dbReduction\": String,
\r\n \"family\": String,
\r\n \"finishType\": String,
\r\n \"frame\": String,
\r\n \"gripType\": String,
\r\n \"handgunSlideMaterial\": String
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/CatalogFeed/Item',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: '[Item #, UPC, MFG Model #]'\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
\r\n Creates an order from a list of items. If an open order exists of the same type (long gun / handgun) it will add to that order,\r\n otherwise a new order is created. The orders are based on the current user by Token.\r\n
\r\nThe shipping location for the order determined by the user credentials used to obtain the Token. If you are unsure what location your email is associated with, please contact your Lipsey's Sales Executive.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"PONumber\": String,
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required [UPC, Lipseys Item Number, Mfg Model #])
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String,
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double,
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/APIOrder',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n PONumber: '[PONumber]',
\r\n DisableEmail: [DisableEmail],
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]',
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Drop Ship - Creates a consumer direct Dropship order for accessories and optics.
\r\nBilling address fields should be completed with your consumer's billing address, which prints on the packing slip.
\r\nA Dropship account is required to submit drop ship orders (separate from normal account).
\r\nPlease Contact Us to create a Dropship account.
\r\nOrders Over $500.00 will be signature required.
\r\nFirearms and NFA / Class 3 items cannot be ordered.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"Warehouse\": String,
\r\n \"PoNumber\": String, (Required)
\r\n \"BillingName\": String, (Required)
\r\n \"BillingAddressLine1\": String, (Required)
\r\n \"BillingAddressLine2\": String,
\r\n \"BillingAddressCity\": String, (Required)
\r\n \"BillingAddressState\": String, (Required, 2 Letters)
\r\n \"BillingAddressZip\": String, (Required, 5 Numbers)
\r\n \"ShippingName\": String, (Required)
\r\n \"ShippingAddressLine1\": String, (Required)
\r\n \"ShippingAddressLine2\": String,
\r\n \"ShippingAddressCity\": String, (Required)
\r\n \"ShippingAddressState\": String, (Required, 2 Letters)
\r\n \"ShippingAddressZip\": String, (Required, 5 Numbers)
\r\n \"MessageForSalesExec\": String,
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required)
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String
\r\n {'}'}
\r\n ],
\r\n \"Overnight\": Bool,
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"lineItems\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double
\r\n {'}'}
\r\n ],
\r\n \"orderNumber\": Int,
\r\n \"accountHold\": Bool,
\r\n \"lineItemChanges\": [String],
\r\n \"freight\": Double,
\r\n \"tax\": Double,
\r\n \"total\": Double
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/DropShip',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n Warehouse: '[Warehouse]',
\r\n PoNumber: '[PoNumber]',
\r\n BillingName: '[BillingName]',
\r\n BillingAddressLine1: '[BillingAddressLine1]',
\r\n BillingAddressCity: '[BillingAddressCity]',
\r\n BillingAddressState: '[BillingAddressState]',
\r\n BillingAddressZip: '[BillingAddressZip]',
\r\n ShippingName: '[ShippingName]',
\r\n ShippingAddressLine1: '[ShippingAddressLine1]',
\r\n ShippingAddressCity: '[ShippingAddressCity]',
\r\n ShippingAddressState: '[ShippingAddressState]',
\r\n ShippingAddressZip: '[ShippingAddressZip]',
\r\n MessageForSalesExec: '[MessageForSalesExec]',
\r\n Overnight: [Overnight],
\r\n DisableEmail: [DisableEmail],
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]'
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Creates a firearms Dropship order that is shipped to a 3rd party firearms dealer based on FFL Number.
\r\nAny orders submitted for FFL locations not on file must be validated before they ship.\r\n A signed FFL copy must be submitted and verified. Please Email validateffl@lipseys.com To Submit FFL.
\r\n All California Orders Should Email The California DOJ Number To validateffl@lipseys.com\r\n
A Lipsey's Dropship account is required to submit drop ship orders (separate from normal account).
\r\nPlease Contact Us to create a Dropship account.
\r\nFirearms Dropship orders can only contain firearms. Accessories should be shipped directly to your customer as a separate fulfillment order.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"Ffl\": String, (Required, 15 Digits)
\r\n \"Po\": String, (Required)
\r\n \"Name\": String, (Required, Your Customer's Name)
\r\n \"Phone\": String, (Required, Your Customer's Phone Number)
\r\n \"DelayShipping\": Bool, (If True Order Ship Date Set To One Week From Time Of Order)
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required)
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"lineItems\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double
\r\n {'}'}
\r\n ],
\r\n \"orderNumber\": Int,
\r\n \"accountHold\": Bool,
\r\n \"lineItemChanges\": [String],
\r\n \"freight\": Double,
\r\n \"tax\": Double,
\r\n \"total\": Double,
\r\n \"misc\": Double
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/DropShipFirearm',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n Ffl: '[15 Digit FFL #]',
\r\n Po: '[PoNumber]',
\r\n DelayShipping: [DelayShipping],
\r\n DisableEmail: [DisableEmail],
\r\n Name: '[Your Consumer's Name]',
\r\n Phone: '[Your Consumer's Phone Number]',
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]'
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
LOGIN - issues a token that to use for all requests. Includes some dealer information.
\r\n\r\n To use the token each request should have a header titled Token
\r\n Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=\r\n
\r\n {'{'}
\r\n \"Email\": String, (Required, Email Format)
\r\n \"Password\": String (Required)
\r\n {'}'}\r\n \r\n {'{'}
\r\n \"token\": String,
\r\n \"econtact\": {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"name\": String,
\r\n \"email\": String,
\r\n \"cusNo\": String,
\r\n \"shipTo\": String,
\r\n \"locationName\": String,
\r\n \"slm\": String,
\r\n {'}'}
\r\n {'}'}
\r\n {'}'}\r\n \r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{LoginUrl}',
\r\n headers: {'{'}
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'} Email: '[Email]', Password: '[Password]' {'}'}
\r\n {'}'};
\r\n
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {\"}\"});\r\n
\r\n \r\n Searches Shipped Orders/Invoices by date and returns the shipping information for each Order/Invoice found.
\r\n\r\n This endpoint should be used once a day, and target the previous day's invoices.\r\n
This endpoint returns data for entire account.\r\n
EX: Today is 2/4/2020, the date provided should be 2/3/2020 or earlier.\r\n
Session Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n Date (Required - Ex: \"7/20/2019\")\r\n
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"invoiceNumber\": String,
\r\n \"orderNumber\": String,
\r\n \"poNumber\": String,
\r\n \"billName\": String,
\r\n \"shipName\": String,
\r\n \"shippingService\": String,
\r\n \"trackingNumber\": String,
\r\n \"weight\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/OneDay',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'},
\r\n body: [Date]\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Don't see a language you need? Let us know!
\r\n\r\n\r\n\r\nSee specific packages' documentation for usage examples.
\r\n\r\n Creates an order from a list of items. If an open order exists of the same type (long gun / handgun) it will add to that order,\r\n otherwise a new order is created. The orders are based on the current user by Token.\r\n
\r\nThe shipping location for the order determined by the user credentials used to obtain the Token. If you are unsure what location your email is associated with, please contact your Lipsey's Sales Executive.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"PONumber\": String,
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required [UPC, Lipseys Item Number, Mfg Model #])
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String,
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double,
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/APIOrder',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n PONumber: '[PONumber]',
\r\n DisableEmail: [DisableEmail],
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]',
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
\r\n Creates an order from a list of items. If an open order exists of the same type (long gun / handgun) it will add to that order,\r\n otherwise a new order is created. The orders are based on the current user by Token.\r\n
\r\n\r\n Will Place orders against customer allocations on items not filled by normal ordering. Items ordered from allocations will not\r\n be grouped with non-allocation orders. If you are a customer with allocations please use this endpoint instead of ApiOrder.\r\n
\r\nThe shipping location for the order determined by the user credentials used to obtain the Token. If you are unsure what location your email is associated with, please contact your Lipsey's Sales Executive.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"PONumber\": String,
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required [UPC, Lipseys Item Number, Mfg Model #])
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String,
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double,
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/AllocationOrder',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n PONumber: '[PONumber]',
\r\n DisableEmail: [DisableEmail],
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]',
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Drop Ship - Creates a consumer direct Dropship order for accessories and optics.
\r\nBilling address fields should be completed with your consumer's billing address, which prints on the packing slip.
\r\nA Dropship account is required to submit drop ship orders (separate from normal account).
\r\nPlease Contact Us to create a Dropship account.
\r\nOrders Over $500.00 will be signature required.
\r\nFirearms and NFA / Class 3 items cannot be ordered.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"Warehouse\": String,
\r\n \"PoNumber\": String, (Required)
\r\n \"BillingName\": String, (Required)
\r\n \"BillingAddressLine1\": String, (Required)
\r\n \"BillingAddressLine2\": String,
\r\n \"BillingAddressCity\": String, (Required)
\r\n \"BillingAddressState\": String, (Required, 2 Letters)
\r\n \"BillingAddressZip\": String, (Required, 5 Numbers)
\r\n \"ShippingName\": String, (Required)
\r\n \"ShippingAddressLine1\": String, (Required)
\r\n \"ShippingAddressLine2\": String,
\r\n \"ShippingAddressCity\": String, (Required)
\r\n \"ShippingAddressState\": String, (Required, 2 Letters)
\r\n \"ShippingAddressZip\": String, (Required, 5 Numbers)
\r\n \"MessageForSalesExec\": String,
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required)
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String
\r\n {'}'}
\r\n ],
\r\n \"Overnight\": Bool,
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"lineItems\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double
\r\n {'}'}
\r\n ],
\r\n \"input\": {'{'}
\r\n \"poNumber\": String,
\r\n \"shipViaCode\": String,
\r\n \"termsCode\": String,
\r\n \"items\": [
\r\n {'{'}
\r\n \"itemNo\": String,
\r\n \"quantity\": Int,
\r\n \"note\": String
\r\n {'}'}
\r\n ],
\r\n \"shippingInstruction1\": String,
\r\n \"shippingInstruction2\": String,
\r\n \"warehouse\": String,
\r\n \"comment1\": String,
\r\n \"comment2\": String,
\r\n \"comment3\": String,
\r\n \"billingAddressLine1\": String,
\r\n \"billingAddressLine2\": String,
\r\n \"billingAddressCity\": String,
\r\n \"billingAddressState\": String,
\r\n \"billingAddressZip\": String,
\r\n \"billingAddressCountry\": String,
\r\n \"shippingAddressLine1\": String,
\r\n \"shippingAddressLine2\": String,
\r\n \"shippingAddressCity\": String,
\r\n \"shippingAddressState\": String,
\r\n \"shippingAddressZip\": String,
\r\n \"shippingAddressCountry\": String,
\r\n \"messageForSalesExec\": String,
\r\n \"cartType\": Int,
\r\n \"delayedShipping\": Bool,
\r\n \"confirmationEmail\": Bool,
\r\n \"shipTo\": String,
\r\n \"achKey\": String,
\r\n \"freightThirdPartyBillingNumber\": String,
\r\n \"freightCost\": Double,
\r\n \"name\": String,
\r\n \"phone\": String,
\r\n \"email\": String,
\r\n \"customFieldName\": String
\r\n {'}'},
\r\n \"orderNumber\": Int,
\r\n \"accountHold\": Bool,
\r\n \"lineItemChanges\": [String],
\r\n \"freight\": Double,
\r\n \"tax\": Double,
\r\n \"total\": Double
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/DropShip',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n Warehouse: '[Warehouse]',
\r\n PoNumber: '[PoNumber]',
\r\n BillingName: '[BillingName]',
\r\n BillingAddressLine1: '[BillingAddressLine1]',
\r\n BillingAddressCity: '[BillingAddressCity]',
\r\n BillingAddressState: '[BillingAddressState]',
\r\n BillingAddressZip: '[BillingAddressZip]',
\r\n ShippingName: '[ShippingName]',
\r\n ShippingAddressLine1: '[ShippingAddressLine1]',
\r\n ShippingAddressCity: '[ShippingAddressCity]',
\r\n ShippingAddressState: '[ShippingAddressState]',
\r\n ShippingAddressZip: '[ShippingAddressZip]',
\r\n MessageForSalesExec: '[MessageForSalesExec]',
\r\n Overnight: [Overnight],
\r\n DisableEmail: [DisableEmail],
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]'
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Creates a firearms Dropship order that is shipped to a 3rd party firearms dealer based on FFL Number.
\r\nAny orders submitted for FFL locations not on file must be validated before they ship.\r\n A signed FFL copy must be submitted and verified. Please Email validateffl@lipseys.com To Submit FFL.
\r\n All California Orders Should Email The California DOJ Number To validateffl@lipseys.com\r\n
A Lipsey's Dropship account is required to submit drop ship orders (separate from normal account).
\r\nPlease Contact Us to create a Dropship account.
\r\nFirearms Dropship orders can only contain firearms. Accessories should be shipped directly to your customer as a separate fulfillment order.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n {'{'}
\r\n \"Ffl\": String, (Required, 15 Digits)
\r\n \"Po\": String, (Required)
\r\n \"Name\": String, (Required, Your Customer's Name)
\r\n \"Phone\": String, (Required, Your Customer's Phone Number)
\r\n \"DelayShipping\": Bool, (If True Order Ship Date Set To One Week From Time Of Order)
\r\n \"DisableEmail\": Bool,
\r\n \"Items\": [ (Required, Minimum 1)
\r\n {'{'}
\r\n \"ItemNo\": String, (Required)
\r\n \"Quantity\": Int, (Required)
\r\n \"Note\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n \r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"lineItems\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"lipseysItemNumber\": String,
\r\n \"note\": String,
\r\n \"requestedQuantity\": Int,
\r\n \"fulfilledQuantity\": Int,
\r\n \"errors\": [String],
\r\n \"exists\": Bool,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"validForCart\": Bool,
\r\n \"validForShipTo\": Bool,
\r\n \"orderError\": Bool,
\r\n \"orderNumber\": Int,
\r\n \"price\": Double,
\r\n \"totalPrice\": Double
\r\n {'}'}
\r\n ],
\r\n \"orderNumber\": Int,
\r\n \"accountHold\": Bool,
\r\n \"lineItemChanges\": [String],
\r\n \"freight\": Double,
\r\n \"tax\": Double,
\r\n \"total\": Double,
\r\n \"misc\": Double
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/DropShipFirearm',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: {'{'}
\r\n Ffl: '[15 Digit FFL #]',
\r\n Po: '[PoNumber]',
\r\n DelayShipping: [DelayShipping],
\r\n DisableEmail: [DisableEmail],
\r\n Name: '[Your Consumer's Name]',
\r\n Phone: '[Your Consumer's Phone Number]',
\r\n Items: [
\r\n {'{'}
\r\n ItemNo: '[ItemNo]',
\r\n Quantity: [Quantity],
\r\n Note: '[Note]'
\r\n {'}'}
\r\n ]
\r\n {'}'},
\r\n json: true
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
POST - Validates item for ordering
\r\nUSE CASE - The Lipsey's Catalog is consumed every few hours and the quantity of items changes regularly.\r\n Using ValidateItem during a website's checkout process can provide a more accurate quantity and help prevent partially filled orders.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n String (Item Number - Required)
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"qty\": Int,
\r\n \"price\": Double,
\r\n \"blocked\": Bool,
\r\n \"allocated\": Bool,
\r\n \"itemNumber\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/ValidateItem',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n Content-Type: 'application/json'
\r\n {'}'},
\r\n body: [ItemNumber]
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Pricing Quantity Feed - Get Catalog pricing and quantity based on logged in account. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\nPricing And Quantity Feed will not update more than once per hour, repeated requests will return cached results.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\nNone
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"nextUpdate\": DateTime,
\r\n \"items\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"upc\": String,
\r\n \"mfgModelNumber\": String,
\r\n \"quantity\": Int,
\r\n \"allocated\": bool,
\r\n \"onSale\": bool,
\r\n \"price\": decimal,
\r\n \"currentPrice\": decimal,
\r\n \"retailMap\": decimal
\r\n {'}'}
\r\n ]
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'GET',
\r\n url: '{url}/PricingQuantityFeed',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'}
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Catalog Feed - Get Catalog details based on logged in account. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\nCatalog feed will not update more then once per four hours, repeated requests will return cached results.
\r\n\r\n Images are available using the imageName fixed onto our image server url: https://www.lipseyscloud.com/images/[image name]
\r\n Example: https://www.lipseyscloud.com/images/siw22045sp.jpg
\r\n Please do not hotlink our images. Download them to your own hosting solution before use.\r\n
Bound book information is not intended to use without checking the firearms you receive, Lipsey's is not responsible for the correctness of dealer bound books.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\nNone
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": [
\r\n {'{'}
\r\n \"itemNo\": String,
\r\n \"description1\": String,
\r\n \"description2\": String,
\r\n \"upc\": String,
\r\n \"manufacturerModelNo\": String,
\r\n \"msrp\": Double,
\r\n \"model\": String,
\r\n \"caliberGauge\": String,
\r\n \"manufacturer\": String,
\r\n \"type\": String,
\r\n \"action\": String,
\r\n \"barrelLength\": String,
\r\n \"capacity\": String,
\r\n \"finish\": String,
\r\n \"overallLength\": String,
\r\n \"receiver\": String,
\r\n \"safety\": String,
\r\n \"sights\": String,
\r\n \"stockFrameGrips\": String,
\r\n \"magazine\": String,
\r\n \"weight\": String,
\r\n \"imageName\": String,
\r\n \"chamber\": String,
\r\n \"drilledAndTapped\": Bool,
\r\n \"rateOfTwist\": String,
\r\n \"itemType\": String,
\r\n \"additionalFeature1\": String,
\r\n \"additionalFeature2\": String,
\r\n \"additionalFeature3\": String,
\r\n \"shippingWeight\": Double,
\r\n \"boundBookManufacturer\": String,
\r\n \"boundBookModel\": String,
\r\n \"boundBookType\": String,
\r\n \"nfaThreadPattern\": String,
\r\n \"nfaAttachmentMethod\": String,
\r\n \"nfaBaffleType\": String,
\r\n \"silencerCanBeDisassembled\": Bool,
\r\n \"silencerConstructionMaterial\": String,
\r\n \"nfaDbReduction\": String,
\r\n \"silencerOutsideDiameter\": String,
\r\n \"nfaForm3Caliber\": String,
\r\n \"opticMagnification\": String,
\r\n \"maintubeSize\": String,
\r\n \"adjustableObjective\": Bool,
\r\n \"objectiveSize\": String,
\r\n \"opticAdjustments\": String,
\r\n \"illuminatedReticle\": Bool,
\r\n \"reticle\": String,
\r\n \"exclusive\": Bool,
\r\n \"quantity\": Int,
\r\n \"allocated\": Bool,
\r\n \"onSale\": Bool,
\r\n \"price\": Double,
\r\n \"currentPrice\": Double,
\r\n \"retailMap\": Double,
\r\n \"fflRequired\": Bool,
\r\n \"sotRequired\": Bool,
\r\n \"scopeCoverIncluded\": Bool,
\r\n \"special\": String,
\r\n \"sightsType\": String,
\r\n \"case\": String,
\r\n \"choke\": String,
\r\n \"dbReduction\": String,
\r\n \"family\": String,
\r\n \"finishType\": String,
\r\n \"frame\": String,
\r\n \"gripType\": String,
\r\n \"handgunSlideMaterial\": String
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'GET',
\r\n url: '{url}/CatalogFeed',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'}
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Catalog Feed Item - Get Catalog details for one item based on logged in account. Item number parameter can be a Lipsey's Item Number, a UPC or a Manufacturer Model Number. If account can order firearms, firearms will be included. If the account can order NFA, nfa will be included.
\r\n\r\n Images are available using the imageName fixed onto our image server url: https://www.lipseyscloud.com/images/[image name]
\r\n Example: https://www.lipseyscloud.com/images/siw22045sp.jpg\r\n
Bound book information is not intended to use without checking the firearms you receive, Lipsey's is not responsible for the correctness of dealer bound books.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\n\r\n String (Required, Item Number)
\r\n [Item Number can be Lipsey's Item #, MFG Model #, or UPC]\r\n
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"itemNo\": String,
\r\n \"description1\": String,
\r\n \"description2\": String,
\r\n \"upc\": String,
\r\n \"manufacturerModelNo\": String,
\r\n \"msrp\": Double,
\r\n \"model\": String,
\r\n \"caliberGauge\": String,
\r\n \"manufacturer\": String,
\r\n \"type\": String,
\r\n \"action\": String,
\r\n \"barrelLength\": String,
\r\n \"capacity\": String,
\r\n \"finish\": String,
\r\n \"overallLength\": String,
\r\n \"receiver\": String,
\r\n \"safety\": String,
\r\n \"sights\": String,
\r\n \"stockFrameGrips\": String,
\r\n \"magazine\": String,
\r\n \"weight\": String,
\r\n \"imageName\": String,
\r\n \"chamber\": String,
\r\n \"drilledAndTapped\": Bool,
\r\n \"rateOfTwist\": String,
\r\n \"itemType\": String,
\r\n \"additionalFeature1\": String,
\r\n \"additionalFeature2\": String,
\r\n \"additionalFeature3\": String,
\r\n \"shippingWeight\": Double,
\r\n \"boundBookManufacturer\": String,
\r\n \"boundBookModel\": String,
\r\n \"boundBookType\": String,
\r\n \"nfaThreadPattern\": String,
\r\n \"nfaAttachmentMethod\": String,
\r\n \"nfaBaffleType\": String,
\r\n \"silencerCanBeDisassembled\": Bool,
\r\n \"silencerConstructionMaterial\": String,
\r\n \"nfaDbReduction\": String,
\r\n \"silencerOutsideDiameter\": String,
\r\n \"nfaForm3Caliber\": String,
\r\n \"opticMagnification\": String,
\r\n \"maintubeSize\": String,
\r\n \"adjustableObjective\": Bool,
\r\n \"objectiveSize\": String,
\r\n \"opticAdjustments\": String,
\r\n \"illuminatedReticle\": Bool,
\r\n \"reticle\": String,
\r\n \"exclusive\": Bool,
\r\n \"quantity\": Int,
\r\n \"allocated\": Bool,
\r\n \"onSale\": Bool,
\r\n \"price\": Double,
\r\n \"currentPrice\": Double,
\r\n \"retailMap\": Double,
\r\n \"fflRequired\": Bool,
\r\n \"sotRequired\": Bool,
\r\n \"scopeCoverIncluded\": Bool,
\r\n \"special\": String,
\r\n \"sightsType\": String,
\r\n \"case\": String,
\r\n \"choke\": String,
\r\n \"dbReduction\": String,
\r\n \"family\": String,
\r\n \"finishType\": String,
\r\n \"frame\": String,
\r\n \"gripType\": String,
\r\n \"handgunSlideMaterial\": String
\r\n {'}'}
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'POST',
\r\n url: '{url}/CatalogFeed/Item',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n 'Content-Type': 'application/json'
\r\n {'}'},
\r\n body: '[Item #, UPC, MFG Model #]'\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n
Allocation Pricing Quantity Feed - Get Catalog pricing and quantity of the logged in account's allocations
\r\nAllocation Pricing And Quantity Feed will not update more than once per hour, repeated requests will return cached results.
\r\nSession Token should be passed as a header as Token.
Ex: Token: nMFW97zPsmmEU64VVSjg8aaO7PhkutYWqvOnAPC9PAE=
To obtain a session token see Authentication
\r\nNone
\r\n {'{'}
\r\n \"success\": Bool,
\r\n \"authorized\": Bool,
\r\n \"errors\": [String],
\r\n \"data\": {'{'}
\r\n \"nextUpdate\": DateTime,
\r\n \"items\": [
\r\n {'{'}
\r\n \"itemNumber\": String,
\r\n \"upc\": String,
\r\n \"mfgModelNumber\": String,
\r\n \"quantity\": Int,
\r\n \"allocated\": bool,
\r\n \"onSale\": bool,
\r\n \"price\": decimal,
\r\n \"currentPrice\": decimal,
\r\n \"retailMap\": decimal
\r\n {'}'}
\r\n ]
\r\n {'}'}\r\n \r\n var request = require(\"request\");
\r\n var options = {'{'}
\r\n method: 'GET',
\r\n url: '{url}/Allocations',
\r\n headers: {'{'}
\r\n Token: 'Token',
\r\n {'}'}
\r\n {'}'};
\r\n request(options, function (error, response, body) {'{'}
\r\n if (error) throw new Error(error);
\r\n console.log(body);
\r\n {'}'});\r\n