GoSweetSpot: List of Printers

GoSweetSpot: List of Printers

Description

Get the list of printers available to you.


Requests

Method: GET
Content Type: application/json
URL: https://api-docs.gosweetspot.com/docs/printers/get.html


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

ParameterTypeDestination
Printerstring

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.

IsLabelPrinterbooleanis the printer a label printer
IsOnlineboolean

is the printer online

LabelTypeintegerrepresents a label type given in below table.
  • EPL_LP2844 : 1
  • EPL_INTERMEC :  2
  • ZPL_GK420D  :  3
  • PNG :  4
  • PDF  : 5
Namestring

Name of the printer

PrinterPathstring

hardware path to the printer

FullNamestring

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)"
  }
]

    • Related Articles

    • GoSweetSpot: API introduction

      In this Documentation: Authentication Rate Limiting Sandbox Account Data Types and Formats Concepts Common Use Cases Endpoints Tracing Your Calls FAQ Freight API provides programmatic access to GSS functionality and content. The API is REST API and ...

    • GoSweetSpot: Printers & Queue

      How to check your printer history You can check the status of your printer and your print history under the Printers & Queue section. Click to Zoom The Printers & Queue page can be used for troubleshooting if you are having trouble printing tickets. ...

    • GoSweetSpot: Shipments

      Get Shipment Updates Description Get status updates for shipments. Requests Method: GET Content Type: application/json URL: https://help.nzcouriers.co.nz/gosweetspot-api-integration/gosweetspot-shipments Headers access_key : your unique API key ...

    • GoSweetSpot: Rates

      Description Query to get available courier services and rates for the destination. Requests Method: POST Content Type: application/json URL: https://api-docs.gosweetspot.com/docs/rates/post.html Headers access_key : your unique API key provided by ...

    • GoSweetSpot: Webhooks

      Description GSS can provide feedback to your site using webhooks for certain action triggers. Actions that can be subscribed to include: Shipment created Shipment pickup registered by courier Shipment delivery registered by courier Shipment tracking ...