Included in this document:
Description
Get the list of printers available to you.
Requests
Method: GET
Content Type: application/json
URL: https://api.gosweetspot.com/api/printers
Headers
access_key : your unique API key provided by GSS.
site_id : which site you are requesting action for.
Return format
An array of objects, each representing a printer available to your user, in JSON format.
Printers
| Parameter | Type | Destination |
|---|---|---|
| Printer | string | Name of the print agent. This name can be passed to the PrintToPrinter field when creating shipments to indicate this printer should be printed to. |
| IsLabelPrinter | boolean | is the printer a label printer |
| IsOnline | boolean | is the printer online |
| LabelType | integer | represents a label type given in below table.
|
| Name | string | Name of the printer |
| PrinterPath | string | hardware path to the printer |
| FullName | string | Full name 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)"
}
]