Skip to main content

api/printers

About 1 min

api/printers

Description

Get the list of printers available to you.

Request

  • Method: GET
  • Content Type: application/json
  • URL: https://api.gosweetspot.com/api/printers

Headers

  • access_key : your unqiue api key provided by GSS.
  • site_id : which site you are requesting action for.

Return format

An array of objects, where each object represents a printer available to your user, in JSON format.

Printer

AttributeTypeDescription
PrinterstringName of the print agent. This name can be passed to the PrintToPrinter field when creating shipments to indicate this printer should be printed to
IsLabelPrinterbooleanis the printer a label printer
IsOnlinebooleanis the printer online
LabelTypeinteger represents a label type given in below table
EPL_LP28441
EPL_INTERMEC2
ZPL_GK420D3
PNG4
PDF5
NamestringName of the printer
PrinterPathstringhardware path to the printer
FullNamestringFullname of the printer
## Request example
curl --location 'https://api.gosweetspot.com/api/printers' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json'

Response example

[
  {
    "Printer": "Warehouse >> NPIA1A447 (HP COLOR LASERJET MFP M277DW) (11111)",
    "IsLabelPrinter": true,
    "IsOnline": true,
    "LabelType": 4,
    "Name": "NPIA1A447 (HP Color LaserJet MFP M277dw)",
    "PrinterPath": "NPIA1A447 (HP Color LaserJet MFP M277dw)",
    "FullName": "SWEET SPOT GROUP LTD >> Warehouse >> NPIA1A447 (HP COLOR LASERJET MFP M277DW) (11111)"
  },
  {
    "Printer": "Warehouse >> ZDESIGNER LP 2844 (COPY 1) (11112)",
    "IsLabelPrinter": true,
    "IsOnline": false,
    "LabelType": 4,
    "Name": "ZDesigner LP 2844 (Copy 1)",
    "PrinterPath": "ZDesigner LP 2844 (Copy 1)",
    "FullName": "SWEET SPOT GROUP LTD >> Warehouse >> ZDESIGNER LP 2844 (COPY 1) (11112)"
  },
  {
    "Printer": "Warehouse >> ZDESIGNER LP 2844 (COPY 1) (11113)",
    "IsLabelPrinter": true,
    "IsOnline": false,
    "LabelType": 4,
    "Name": "ZDesigner LP 2844 (Copy 1)",
    "PrinterPath": "ZDesigner LP 2844 (Copy 1)",
    "FullName": "SWEET SPOT GROUP LTD >> Warehouse >> ZDESIGNER LP 2844 (COPY 1) (11113)"
  }
]
Last update: