eBound Book API Documentation

eBound Book API Documentation

API Post Requirements

  1. Must be a POST
  2. JSON format
  3. In the Request Header
    1. Pass the authentication token
      1. X-Api-Auth-Token: Individually Generated by Bound Book. NOTE: API tokens are generated by Orchid Advisors and will be done so per client request.
    2. Set the content type
      1. Content-Type: application/json
    3. Pass the key/value for transaction-Type
      1. Transaction-Type: From List Selection Only
        1. Serialize
        2. Receive
        3. Exempt transfer
        4. FFL transfer
        5. Loan out
        6. Loan return
        7. Assemble
        8. Disassemble
        9. Theft
        10. Destroy
        11. Found

Authentication and Identification

  1. Each eBound Book has its own authentication token which directs which book to post transactions.
  2. Each transaction includes the authentication token in the request header (X-Api-Auth- Token).

URL to Post API Request - Live Environment

Field Limitations

  1. The maximum length of any field within the eBound Book system is 50 characters, including spaces.

Queue Table & Error Log

  1. All transactions are stored in a queue table. A service will monitor the table for changes and if there are changes (new records) then the service will process each of the transactions and report on its status.
  2. The system will maintain a log of all API Errors for the last 30 days, available within the eBound Book system.
  3. To view the API Error Log: Last 30 Days:
    1. From the eBound Book Dashboard, click API Error Log or, from any page within in the eBound Book Reports and Monitoring heading, select API Error Log.

 
  1. The API Error Log: Last 30 Days will now display.
 

Required vs Optional Fields

Required

  1. Field Name AND Data Point MUST be included in call
    1. Example
      1. "Manufacturer":"SBR Manufacturer"

Optional

  1. Field Name ONLY Must be included in call
  2. Data Point for Field is NOT required
    1. Example
      1. "CountryOfManufacturer

Transactions

Serialize

  1. Accepts firearm to serialize in JSON format
  2. Transaction-Type: Serialize

 

API Submission – Required Fields:

  1. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  2. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm serialized
  3. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  4. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  5. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  6. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

API Submission – Optional Fields

  1. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  2. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  3. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  4. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters
  5. Importer 
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  6. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm

Receive

  1. Accepts firearm to receive/acquire in JSON format
  2. Transaction-Type: Receive

API Submission – Required Fields:

  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm arrived on FFL premises
  2. Acquired From Name
    1. Exact field name: FFLFrom Name (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Acquired from name as indicated on ATF issued license / Form
  3. Acquired From Address
    1. Exact field name: FFLFrom Address (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Acquired from premises address as indicated on ATF issued license / Form
  4. Acquired From City      
    1. Exact field name: FFLFrom City (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Acquired from premises city as indicated on ATF issued license / Form
  5. Acquired From State
    1. Exact field name: FFLFrom State (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Acquired from premises state as indicated on ATF issued license / Form
  6. Acquired From Zip
    1. Exact field name: FFLFrom Zip (See FFL Information)
    2. Maximum Length: 9 Characters
      1. May NOT included dashes (-) or spaces
  7. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  8. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  9. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  10. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  11. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

 

API Submission – Optional Fields:


  1. Acquired From FFL
    1. Exact field name: FFL (See FFL Information)
    2. Maximum Length: Complete, 15 Character FFL
      1. May NOT included dashes (-) or spaces
    3. Acquired from FFL as indicated on ATF issued license / Form
  2. Acquired From SOT
    1. Exact field name: From (See FFL Information)
    2. Maximum Length: 50 Characters
    3. SOT EIN as indicated on ATF issued license / Form
  3. Acquired From Country
    1. Exact field name: FFL (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Acquired from premises country as indicated on ATF issued license / Form
  4. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  5. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters  
    3. User defined; may be any string of letters and/or numbers
  6. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  7. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  8. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  9. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters

Exempt Transfer

  1. Accepts firearm transferred/disposed to an exempt, non-licensee in JSON format
  2. Transaction-Type: Exempt transfer

 

API Submission – Required Fields:


  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm left FFL premises
  2. Disposed to Name
    1. Exact field name: FFLTo name (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to name as indicated on ATF issued license / Form
  3. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  4. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  5. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  6. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  7. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

API Submission – Optional Fields:


  1. Disposed to FFL
    1. Exact field name: FFLTo (See FFL Information)
    2. Maximum Length: Complete, 15 Character FFL
      1. May NOT included dashes (-) or spaces
    3. Disposed to FFL as indicated on ATF issued license / Form
  2. Disposed to SOT
    1. Exact field name: SOT (See FFL Information)
    2. Maximum Length: 50 Characters
    3. SOT EIN as indicated on ATF issued license / Form
  3. Disposed to Country
    1. Exact field name: Country (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises country as indicated on ATF issued license / Form
  4. Disposed to Address
    1. Exact field name: FFL To address (See FFL Information
  5. Disposed to City
    1. Exact field name: FFL From City (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises address as indicated on ATF issued license / Form
  6. Disposed to State
    1. Exact field name: FFL From State (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises state as indicated on ATF issued license / Form
  7. Disposed to Zip
    1. Exact field name: FFL From Zip (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises zip as indicated on ATF issued license / Form
  8. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  9. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  10. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  11. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  12. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  13. Lot Number
    1. Exact field name: Location
    2. Maximum Length: 50 Characters

FFL Transfer

  1. Accepts firearm transferred/disposed to an FFL in JSON format
  2. Transaction-Type: Ffl transfer

 

API Submission – Required Fields:


  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm left FFL premises
  2. Disposed to FFL
    1. Exact field name: FFLTo (See FFL Information)
    2. Maximum Length: Complete, 15 Character FFL
      1. May NOT included dashes (-) or spaces
    3. Disposed to FFL as indicated on ATF issued license / Form
  3. Disposed to Name
    1. Exact field name: FFLTo name (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to name as indicated on ATF issued license / Form
  4. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  5. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  6. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  7. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  8. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

 

API Submission – Optional Fields:


  1. Disposed to SOT
    1. Exact field name: SOT (See FFL Information)
    2. Maximum Length: 50 Characters
    3. SOT EIN as indicated on ATF issued license / Form
  2. Disposed to Country
    1. Exact field name: Country (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises country as indicated on ATF issued license / Form
  3. Disposed to Address
    1. Exact field name: FFL To address (See FFL Information
  4. Disposed to City
    1. Exact field name: FFL From City (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises address as indicated on ATF issued license / Form
  5. Disposed to State
    1. Exact field name: FFL From State (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises state as indicated on ATF issued license / Form
  6. Disposed to Zip
    1. Exact field name: FFL From Zip (See FFL Information)
    2. Maximum Length: 50 Characters
    3. Disposed to premises zip as indicated on ATF issued license / Form
  7. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  8. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  9. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  10. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  11. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  12. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters

Loan Out

  1. Accepts firearm loaned out to employees in JSON format
  2. Transaction-Type: Loan out

 

API Submission – Required Fields:


  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm loaned out
  2. Loaned to Name
    1. Exact field name: LoanTo name (See Loan Information)
    2. Maximum Length: 50 Characters
    3. Name to which firearm is loaned out
  3. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  4. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  5. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  6. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  7. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

 


API Submission – Optional Fields:


  1. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  2. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  3. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  4. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  5. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  6. Lot Number
    1. Exact field name: Lot Number
    2. Maximum Length: 50 Characters 

Loan Return

  1. Accepts firearm returned from loan from employees in JSON format
  2. Transaction-Type: Loan return

 

API Submission – Required Fields:

  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm returned from loan out
  2. Loaned to Name:
    1. Exact field name: LoanTo name (See Loan Information)
    2. Maximum Length: 50 Characters
    3. Name to which firearm is loaned out
  3. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  4. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  5. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  6. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  7. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm

 


API Submission – Optional Fields:


  1. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  2. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  3. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  4. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  5. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  6. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters


Assemble

  1. Accepts firearm assembled in JSON format
  2. Transaction-Type: Assemble

 

API Submission – Required Fields:

  1.    Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm changed form from one type / SKU / Item No. to another
  2. Start Good Information
    1. Exact field name: good (See Assemble/Disassemble Information)
    2. Manufacturer
      1. Exact field name: Manufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
    3. Type
      1. Exact field name: Type (See Item Information)
      2. Case Sensitive Input
        1. Cannot Contain Additional Spaces Before/After Type Name
      3. MUST be One of Available Options
        1. Any Other Weapon
        2. Barreled Action
        3. Destructive Device
        4. Drop in Auto Sear
        5. Frame
        6. Machine Gun
        7. Machine Gun Receiver
        8. Pistol
        9. Pistol Grip Only Firearm
        10. Receiver
        11. Revolver
        12. Rifle
        13. Rifle / Shotgun Combo
        14. Short Barreled RifleShort Barreled Shotgun
        15. Shotgun
        16. Silencer
    4. Model
      1. Exact field name: Model (See Item Information)
      2. Maximum Length: 50 Characters
      3. Model of firearm as engraved or otherwise marked on the firearm
    5. Caliber or Gauge
      1. Exact field name: CaliberGuage (See Item Information)
      2. Maximum Length: 50 Characters
      3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
    6. Serial Number
      1. Exact field name: SerialNumber (See Item Information)
      2. Maximum Length: 50 Characters
      3. Serial Number as engraved or otherwise marked on the firearm
  3. End Good Information
    1. Exact field name: component (See Assemble/Disassemble Information)
    2. Manufacturer
      1. Exact field name: Manufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
    3. Type
      1. Exact field name: Type (See Item Information)
      2. Case Sensitive Input
        1. Cannot Contain Additional Spaces Before/After Type Name
      3. MUST be One of Available Options
        1. Any Other Weapon
        2. Barreled Action
        3. Destructive Device
        4. Drop in Auto Sear
        5. Frame
        6. Machine Gun
        7. Machine Gun Receiver
        8. Pistol
        9. Pistol Grip Only Firearm
        10. Receiver
        11. Revolver
        12. Rifle
        13. Rifle / Shotgun Combo
        14. Short Barreled Rifle
        15. Short Barreled Shotgun
        16. Shotgun
        17. Silencer
    4. Model
      1. Exact field name: Model (See Item Information)
      2. Maximum Length: 50 Characters
      3. Model of firearm as engraved or otherwise marked on the firearm
    5. Caliber or Gauge
      1. Exact field name: CaliberGuage (See Item Information)
      2. Maximum Length: 50 Characters
      3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
    6. Serial Number
      1. Exact field name: SerialNumber (See Item Information)
      2. Maximum Length: 50 Characters
      3. Serial Number as engraved or otherwise marked on the firearm
API Submission – Optional Fields:
  1. Start Good Information:Exact field name: good (See Start Good Information)
    1. 3310.12 Reportable
      1. Exact field name: Reportable3310_12 (See 331012 Reportable Information)
      2. MUST be One of Available Options
        1. Yes
        2. No
    2. Item No./SKU
      1. Exact field name: SKU (See Item Information)
      2. Maximum Length: 50 Characters
      3. User defined; may be any string of letters and/or numbers
    3. Importer
      1. Exact field name: Importer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
    4. Country of Manufacture
      1. Exact field name: CountryOfManufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
    5. Location
      1. Exact field name: Location
      2. Maximum Length: 50 Characters
    6. Lot Number
      1. Exact field name: lotNumber
      2. Maximum Length: 50 Characters
  2. End Good Information: Exact field name: component (See Assemble/Disassemble Information)
    1. 3310.12 Reportable
      1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
      2. MUST be One of Available Options
        1. Yes
        2. No
    2. Item No./SKU
      1. Exact field name: SKU (See Item Information)
      2. Maximum Length: 50 Characters
      3. User defined; may be any string of letters and/or numbers
    3. Importer
      1. Exact field name: Importer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
    4. Country of Manufacture
      1. Exact field name: CountryOfManufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
    5. Location
      1. Exact field name: Location
      2. Maximum Length: 50 Characters
    6. Lot Number
      1. Exact field name: lotNumber
      2. Maximum Length: 50 Characters

Disassemble

  1. Accepts firearm disassembled in JSON format
  2. Transaction-Type: Disassemble


 

    API Submission – Required Fields:

  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm changed form from one type / SKU / Item No. to another
  2. Start Good Information
    1. Exact field name: good (See Assemble/Disassemble Information)     
    2. Manufacturer
      1. Exact field name: Manufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
    3. Type
      1. Exact field name: Type (See Item Information)
      2. Case Sensitive Input
        1. Cannot Contain Additional Spaces Before/After Type Name
      3. MUST be One of Available Options
        1. Any Other Weapon
        2. Barreled Action
        3. Destructive Device
        4. Drop in Auto Sear
        5. Frame
        6. Machine Gun
        7. Machine Gun Receiver
        8. Pistol
        9. Pistol Grip Only Firearm
        10. Receiver
        11. Revolver
        12. Rifle
        13. Rifle / Shotgun Combo
        14. Short Barreled Rifle
        15. Short Barreled Shotgun
        16. Shotgun
        17. Silencer
    4. Model
      1. Exact field name: Model (See Item Information)
      2. Maximum Length: 50 Characters
      3. Model of firearm as engraved or otherwise marked on the firearm
    5. Caliber or Gauge
      1. Exact field name: CaliberGuage (See Item Information)
      2. Maximum Length: 50 Characters
      3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
    6. Serial Number
      1. Exact field name: SerialNumber (See Item Information)
      2. Maximum Length: 50 Characters
      3. Serial Number as engraved or otherwise marked on the firearm
  3. End Good Information
    1. Exact field name: component (See Assemble/Disassemble Information)
    2. Manufacturer
      1. Exact field name: Manufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
    3. Type
      1. Exact field name: Type (See Item Information)
      2. Case Sensitive Input
        1. Cannot Contain Additional Spaces Before/After Type Name
      3. MUST be One of Available Options
        1. Any Other Weapon
        2. Barreled Action
        3. Destructive Device
        4. Drop in Auto Sear
        5. Frame
        6. Machine Gun
        7. Machine Gun Receiver
        8. Pistol
        9. Pistol Grip Only Firearm
        10. Receiver
        11. Revolver
        12. Rifle
        13. Rifle / Shotgun Combo
        14. Short Barreled Rifle
        15. Short Barreled Shotgun
        16. Shotgun
        17. Silencer
    4. Model
      1. Exact field name: Model (See Item Information)
      2. Maximum Length: 50 Characters
      3. Model of firearm as engraved or otherwise marked on the firearm
    5. Caliber or Gauge
      1. Exact field name: CaliberGuage (See Item Information)
      2. Maximum Length: 50 Characters
      3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
    6. Serial Number
      1. Exact field name: SerialNumber (See Item Information)
      2. Maximum Length: 50 Characters
      3. Serial Number as engraved or otherwise marked on the firearm
API Submission – Optional Fields:
  1. Start Good Information: Exact field name: good (See Start Good Information)
    1. 3310.12 Reportable
      1. Exact field name: Reportable3310_12 (3310.12 Reportable Information)
      2. MUST be One of Available Options
        1. Yes
        2. No
    2. Item No./SKU
      1. Exact field name: SKU (See Item Information)
      2. Maximum Length: 50 Characters
      3. User defined; may be any string of letters and/or numbers
    3. Importer
      1. Exact field name: Importer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
    4. Country of Manufacture
      1. Exact field name: CountryOfManufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
    5. Location
      1. Exact field name: Location
      2. Maximum Length: 50 Characters
    6. Lot Number
      1. Exact field name: lotNumber
      2. Maximum Length: 50 Characters
  2. End Good Information: Exact field name: component (See Assemble/Disassemble Information
    1. 3310.12 Reportable
      1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
      2. MUST be One of Available Options
        1. Yes
        2. No
    2. Item No./SKU
      1. Exact field name: SKU (See Item Information)
      2. Maximum Length: 50 Characters
      3. User defined; may be any string of letters and/or numbers
    3. Importer
      1. Exact field name: Importer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
    4. Country of Manufacture
      1. Exact field name: CountryOfManufacturer (See Item Information)
      2. Maximum Length: 50 Characters
      3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
    5. Location
      1. Exact field name: Location
      2. Maximum Length: 50 Characters
    6. Lot Number
      1. Exact field name: lotNumber
      2. Maximum Length: 50 Characters

Theft

  1. Accepts firearm submitted as theft/loss in JSON format
  2. Transaction-Type: Theft
 
API Submission – Required Fields:
  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm lost or stolen
  2. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  3. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
      2. MUST be One of Available Options
        1. Any Other Weapon
        2. Barreled Action
        3. Destructive Device
        4. Drop in Auto Sear
        5. Frame
        6. Machine Gun
        7. Machine Gun Receiver
        8. Pistol
        9. Pistol Grip Only Firearm
        10. Receiver
        11. Revolver
        12. Rifle
        13. Rifle / Shotgun Combo
        14. Short Barreled Rifle
        15. Short Barreled Shotgun
        16. Shotgun
        17. Silencer
  4. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  5. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  6. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm
  7. Theft/Loss #, Indication of Theft OR Loss, Local LE Case #:
    1. Exact field name: theftNumber (See Theft/Loss Information)
API Submission – Optional Fields:
  1. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  2. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  3. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  4. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  5. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  6. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters

Destroy

  1. Accepts firearm submitted as destroyed in JSON format
  2. Transaction-Type: Destroy

 API Submission – Required Fields:


  1. Physical Date
    1.  Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm destroyed
  2. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  3. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name 
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  4. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  5. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  6. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm
API Submission – Optional Fields:
  1. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  2. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  3. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  4. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  5. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  6. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters

Found

  1. Accepts firearm acquired as found in JSON format
  2. Transaction-Type: Found
API Submission – Required Fields:
  1. Physical Date
    1. Exact field name: PhysicalDate (See Physical Date Information)
    2. Date firearm found on FFL premises
  2. Manufacturer
    1. Exact field name: Manufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm manufacturer as engraved or otherwise marked on the firearm
  3. Type
    1. Exact field name: Type (See Item Information)
    2. Case Sensitive Input
      1. Cannot Contain Additional Spaces Before/After Type Name
    3. MUST be One of Available Options
      1. Any Other Weapon
      2. Barreled Action
      3. Destructive Device
      4. Drop in Auto Sear
      5. Frame
      6. Machine Gun
      7. Machine Gun Receiver
      8. Pistol
      9. Pistol Grip Only Firearm
      10. Receiver
      11. Revolver
      12. Rifle
      13. Rifle / Shotgun Combo
      14. Short Barreled Rifle
      15. Short Barreled Shotgun
      16. Shotgun
      17. Silencer
  4. Model
    1. Exact field name: Model (See Item Information)
    2. Maximum Length: 50 Characters
    3. Model of firearm as engraved or otherwise marked on the firearm
  5. Caliber or Gauge
    1. Exact field name: CaliberGuage (See Item Information)
    2. Maximum Length: 50 Characters
    3. Firearm caliber or gauge as engraved or otherwise marked on the firearm
  6. Serial Number
    1. Exact field name: SerialNumber (See Item Information)
    2. Maximum Length: 50 Characters
    3. Serial Number as engraved or otherwise marked on the firearm
API Submission – Optional Fields:
  1. 3310.12 Reportable
    1. Exact field name: Reportable3310_12 (See 3310.12 Reportable Information)
    2. MUST be One of Available Options
      1. Yes
      2. No
  2. Item No./SKU
    1. Exact field name: SKU (See Item Information)
    2. Maximum Length: 50 Characters
    3. User defined; may be any string of letters and/or numbers
  3. Importer
    1. Exact field name: Importer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Name of firearm importer, if any, as engraved or otherwise marked on the firearm
  4. Country of Manufacture
    1. Exact field name: CountryOfManufacturer (See Item Information)
    2. Maximum Length: 50 Characters
    3. Country of firearm manufacture (e.g. US) as engraved or otherwise marked on the firearm
  5. Location
    1. Exact field name: Location
    2. Maximum Length: 50 Characters
  6. Lot Number
    1. Exact field name: lotNumber
    2. Maximum Length: 50 Characters
Physical Date Information

Field
Exact Field Name
Format
Physical Date
PhysicalDate
mm/dd/yyy hh:mm
Definition
Actual date acquisition or disposition transaction occurred

Item Information


Field
Exact Field Name
Format
Item No./SKU
SKU
50 Character Max
Definition
Item number or SKU for associated firearm.

Field
Exact Field Name
Format
Manufacturer
Manufacturer
50 Character Max
Definition
Manufacturer of firearm as engraved or otherwise marked on firearm.


 

Field

Exact Field Name

Format

Type

Type

List Selection Only

Definition

Type of firearm(s); ONLY accepts Type allowable by system. Field is Case Sensitive.

Options

Any Other Weapon

Receiver

Barreled Action

Revolver

Destructive Device

Rifle

Drop in Auto Sear

Rifle / Shotgun Combo

Frame

Short Barreled Rifle

Machine Gun

Short Barreled Shotgun

Machine Gun Receiver

Shotgun

Pistol

Silencer

Pistol Grip Firearm

 





 

Field

Exact Field Name

Format

Model

Model

50 Character Max

Definition

Model of firearm as engraved or otherwise marked on firearm.

 

Field

Exact Field Name

Format

Caliber or Gauge

CaliberGuage

50 Character Max

Definition

Caliber or Gauge as engraved or otherwise marked on firearm.


 

Field

Exact Field Name

Format

Serial Number

SerialNumber

50 Character Max

Definition

Serial Number as engraved or otherwise marked on firearm.

 

Field

Exact Field Name

Format

Importer

Importer

50 Character Max

Definition

Importer (if any) as engraved or otherwise marked on firearm.

 

Field

Exact Field Name

Format

Country of Manufacture

CountryOfManufacturer

50 Character Max

Definition

Country of Manufacture (if imported) as engraved or otherwise marked on firearm.

 

Field

Exact Field Name

Format

3310.12 Reportable?

Reportable3310_12

List Selection Only

Definition

Indication if firearm qualifies as a certain type rifle required for multiple sales reporting via ATF Form 3310.12.

Options

Yes

No





 

FFL Information

Field

Exact Field Name

Format

Name

Name

50 Character Max

No Dashes (-) or Spaces

Definition

Name of FFL firearm are acquired/disposed, exactly as it appears on ATF Issued Federal Firearms License (FFL) or

Form.

 

Field

Exact Field Name

Format

Address

Address

50 Character Max

Definition

Address of FFL premises from/to which firearm(s) are acquired/disposed from, exactly as it appears on ATF Issued

Federal Firearms License (FFL) or Form.

 

Field

Exact Field Name

Format

City

City

50 Character Max

Definition

City of FFL premises from/to which firearm(s) are acquired/disposed from, exactly as it appears on ATF Issued Federal

Firearms License (FFL) or Form.



 

Field

Exact Field Name

Format

State

State

50 Character Max

Definition

State of FFL premises from/to which firearm(s) are acquired/disposed from, exactly as it appears on ATF Issued

Federal Firearms License (FFL) or Form.

 

Field

Exact Field Name

Format

Zip

Zip

9 Character Max

No Dashes (-) or Spaces

Definition

Zip Code of FFL premises from/to which firearm(s) are acquired/disposed from, exactly as it appears on ATF Issued

Federal Firearms License (FFL) or Form.

 

Field

Exact Field Name

Format

Disposed to FFL

FFLTo

15 Character Max

No Dashes (-) or Spaces

Definition

FFL Number, exactly as it appears on ATF Issued Federal Firearms License (FFL) or Form WITHOUT spaces or dashes.

 

Field

Exact Field Name

Format

Acquired From FFL

FFLFrom

15 Character Max

No Dashes (-) or Spaces

Definition

FFL Number, exactly as it appears on ATF Issued Federal Firearms License (FFL) or Form WITHOUT spaces or dashes.

 

Field

Exact Field Name

Format

SOT

SOT

50 Character Max

Definition

SOT Number, exactly as it appears on ATF Issued SOT.

 

Field

Exact Field Name

Format

Country

Country

50 Character Max

Definition

Country from/to which firearm(s) will be acquired/disposed.

 

Loan Information

Field

Exact Field Name

Format

Loan To/From

LoanTo

50 Character Max

Definition

Name of Employee firearm(s) were loaned to or returned from loan.


Theft/Loss Information

Field

Exact Field Name

Format

Theft/Loss #

theftNumber

50 Character Max

Definition

Must include ATF Issued Incident Number provided when reporting Theft/Loss, indication of Theft OR Loss, and local

law enforcement case number.

 

Assemble/Disassemble Information

Field

Exact Field Name

Format

Start Good Information

good

 

Definition

Indicates information below this point in API call is for the starting good.

 

Field

Exact Field Name

Format

End Good Information

component

 

Definition

Indicates information below this point in API call is for the ending good.

 

3310.12 Reportable Information

Field

Exact Field Name

Format

3310.12 Reportable?

Reportable3310_12

List Selection Only

Definition

Indication if firearm qualifies as a certain type rifle required for multiple sales reporting via ATF Form 3310.12.

Options

Yes

No


Transaction Examples Header Example

POST /api/transactions/queue HTTP/1.1

Host: app.fflbizhub.com

X-Api-Auth-Token: password Content-Type: application/json Transaction-type: serialize cache-control: no-cache

Postman-Token: abcde-123340-ajdlfkjflasf-19i091i

 

Serialize Example [

{

"serialNumber":"KAHR-2000-AT", "Location":"",

"lotNumber":"", "SKU":"6026863130566",

"Manufacturer":"Kahr Arms",

"Importer":"", "CountryOfManufacturer":"USA", "Type":"Rifle", "Model":"M1",

"CaliberGuage":"30 Carbine", "PhysicalDate":"9/24/2018",

}

Receive Example [

{

"serialNumber":"KAHR-9005-AT", "Location":"",

"lotNumber":"", "SKU":"6026863130566",

"Manufacturer":"Kahr Arms",

"Importer":"", "CountryOfManufacturer":"", "Type":"Rifle", "Model":"M1",

"CaliberGuage":"30 Carbine", "PhysicalDate":"9/21/2018", "fflFrom":{ "Name":"RSR Group Inc", "FFL":"575439010D26128",

"SOT":"",

"Address":"4700 Amon Carter Blvd", "City":"Fort Worth",

"State":"TX",

"Zip":"76155",

"Country":"US",

}

}


]]



Exempt Transfer Example [


{

"serialNumber":"9876", "Location":"",

"lotNumber":"",

"SKU":"2018SBR-Comp",

"Manufacturer":"SBR Manufacturer",

"Importer":"SBR Importer", "CountryOfManufacturer":"BZ", "Type":"Receiver", "Model":"SBR A1",

"CaliberGuage":"None", "PhysicalDate":"1/28/2019", "fflTo":{ "Name":"Nashville PD",

"FFL":"",

"SOT":"",

"Address":"1234 Music Way", "City":"Nashville",

"State":"TN",

"Zip":"01234",

"Country":"US",

"Type":"",

}

}

]



FFL Transfer Example [


{

"serialNumber":"KAHR-9503-AT", "Location":"",

"lotNumber":"",

"SKU":"Unknown", "Manufacturer":"Kahr Arms",

"Importer":"", "CountryOfManufacturer":"USA", "Type":"Rifle", "Model":"M1",

"CaliberGuage":"30 Carbine", "PhysicalDate":"3/27/2019 14:15", "fflTo":{ "Name":"Bi-Mart Corporation", "FFL":"993001011G00098",

"SOT":"",

"Address":"700 Campbell Street", "City":"Baker City",

"State":"OR",

"Zip":"97814",

"Country":"US",

"Type":"Test 1",

}

}

]

 

Loan Out Example [

{

"serialNumber":"Rifle-1001-ATR1v1", "Location":"",

"lotNumber":"",

"SKU":"12345",

"Manufacturer":"Rifle MFG",

"Importer":"", "CountryOfManufacturer":"", "Type":"Rifle", "Model":"Rifle A1",

"CaliberGuage":"45 ACP", "PhysicalDate":"09/25/2018", "loanTo":"Snoopy Dog", "dataID":""

}

]



Loan Return Example [

{

"serialNumber":"Rifle-1001-ATR1v1", "Location":"",

"lotNumber":"",

"SKU":"12345",

"Manufacturer":"Rifle MFG",

"Importer":"", "CountryOfManufacturer":"", "Type":"Rifle", "Model":"Rifle A1",

"CaliberGuage":"45 ACP", "PhysicalDate":"09/26/2018", "loanTo":"Snoopy Dog", "dataID":""

}

]

 

Assemble Example [

{

"PhysicalDate":"09/25/2018", "good":{

"CaliberGuage":"308 WIN", "CountryOfManufacturer":"AZ", "Importer":"", "Manufacturer":"Best FFL Inc", "Model":"Riffle Assembled 1",

"serialNumber":"Receiver-1004-ATR1v1", "SKU":"98765",

"Type":"Rifle",

},

"component":{ "CaliberGuage":"None", "CountryOfManufacturer":"AZ", "Importer":"Receiver Importer", "Manufacturer":"Receiver MFG", "Model":"Receiver A1",

"serialNumber":"Receiver-1004-ATR1v1", "SKU":"98765",

"Type":"Receiver",

}

}

]



Disassemble Example [

{

"PhysicalDate":"09/25/2018", "good":{

"CaliberGuage":"308 WIN", "CountryOfManufacturer":"AZ", "Importer":"", "Manufacturer":"Best FFL Inc", "Model":"Riffle Assembled 1",

"serialNumber":"Receiver-1004-ATR1v1", "SKU":"98765",

"Type":"Rifle",

},

"component":{ "CaliberGuage":"None", "CountryOfManufacturer":"AZ", "Importer":"Receiver Importer", "Manufacturer":"Receiver MFG", "Model":"Receiver A1",

"serialNumber":"Receiver-1004-ATR1v1", "SKU":"98765",

"Type":"Receiver",

}

}

]

 

Theft Example [

{

"serialNumber":"Receiver-1004-ATR1v1", "Location":"",

"lotNumber":"",

"SKU":"98765",

"Manufacturer":"Receiver MFG",

"Importer":"Receiver Importer", "CountryOfManufacturer":"AZ", "Type":"Receiver", "Model":"Receiver A1",

"CaliberGuage":"None", "PhysicalDate":"09/25/2018", "theftNumber":"ABC12345678 THEFT Case#:abc123"

}

]


Destroy Example [

{

"serialNumber":"Shotgun-1000-ATR1v1", "Location":"",

"lotNumber":"",

"SKU":"369258",

"Manufacturer":"Shotgun MFG",

"Importer":"", "CountryOfManufacturer":"US", "Type":"Shotgun", "Model":"Shotgun A1",

"CaliberGuage":"20 GA", "PhysicalDate":"09/25/2018",

}

]

 

Found Example [

{

"serialNumber":"Shotgun-1000-ATR1v1", "Location":"",

"lotNumber":"",

"SKU":"369258",

"Manufacturer":"Shotgun MFG",

"Importer":"", "CountryOfManufacturer":"US", "Type":"Shotgun", "Model":"Shotgun A1",

"CaliberGuage":"20 GA", "PhysicalDate":"09/25/2018",

}

]

OrchidPOS and 4473 (eBound Book) integration Document

 

Step 1 - Generate Session Token to begin the 4473

 

Send the following request to eBound Book and it will return the token.

Make sure the credentials are correct and the serial numbers should be formatted correctly.

 

Request

 

curl --location --request POST 'https://app.fflbizhub.com/api/4473/SearchSerialNumbers' \

--header 'X-DailyDownload-Auth-Email: \

--header 'X-DailyDownload-Auth-Password:  \

--header 'Content-Type: application/json' \

--data-raw '{

    "serialNumbers": ["082721_e","082721_d","082721_c"]

}'

 

Response

 

{

    "success": true,

    "message": "All serial numbers are available",

    "session": "7e57e9c0b6a44811ba9982013922ab41"

}

Step 2 – Open the unique 4473 URL

 

https://app.fflbizhub.com/portal/eAd/Start4473B?Session=[KeyGoesHere]

Pass the session generated in the previous step to the above URL. Make sure you are logged in to the eBound book before opening the following URL.

https://app.fflbizhub.com/portal/ead/start4473b?Session=7e57e9c0b6a44811ba9982013922ab41

 

The 4473 wizard should initiated and when you click proceed, all the serial numbers that you entered in the first step should be auto populated.

 






    • Related Articles

    • Orchid eBound - Technical Support

      API Documentation Creating and Managing eBound Books Creating Data Back ups Generating Reports Managing Master Data Managing Users Performing Special Transactions Performing Transactions in eBound Books Searching your A&D Book Software Updates The ...
    • Creating and Managing eBound Books

      Creating your eBound Books Note: Only Company Admin users may add, remove, and edit FFLs and eBound Books in the Manage FFLs transaction. Log in to the Orchid Software Portal using the credentials for your Company Admin account Select Orchid eBound, ...
    • Orchid eBound Quick Start Guide

      Welcome to Orchid eBound!  The steps contained within this guide will get you started in your new eBound Books.  More details for each step can be found in their respective articles. Step 1 - Create Your eBound Book(s) Note: Only Company Admin users ...
    • Performing Transactions in eBound Books

      Once your eBound Book has been created and your account has had access granted to it, the Transactions heading will be available in the Orchid eBound Book menu.  The Transactions will allow you to perform day-to-day operations within your eBound ...
    • Searching your A&D Book

      Search / Query • Under the heading Bound Book Search, select Search / Query. Note ONLY users with assigned permissions may access the Search / Query area. • The A&D Book screen will now display. Entries are sorted automatically by most recent date of ...