• getList printers in a store
• postCreate printer in a store
• getGet printer in a store
• putUpdate printer
• delDelete printer

API docs by Redocly

Printers API (v1)

Download OpenAPI specification:Download

Use this API to retrieve, create, update, or delete printers for stores in your business.

Associate App uses this API for printer management, but the API can also be used for printer management for support operations.

List printers in a store

Lists all printers for the specified store, using the store ID.

Responses

/api/v1/associate-app/store/%7BstoreId%7D/printers

Response samples

• 200

Content type

application/json

[

• {

  • "manufacturer": "epsonFiscal",
  • "name": "string",
  • "documentTypes": [

    • "salesReceipt"

    ],
  • "model": "string",
  • "macAddress": "string",
  • "ipAddress": "string",
  • "port": 0,
  • "serialNumber": "string",
  • "scalingFactor": 0,
  • "offsetTop": 0,
  • "offsetLeft": 0,
  • "interfaceType": "string",
  • "identifier": "string",
  • "paperWidth": 0,
  • "networkName": "string",
  • "url": "string"

  }

]

Create printer in a store

Creates a new printer configuration for the specified store ID.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

>= 3 properties

One of

>= 3 properties

required	"epsonFiscal" (string) or "posnetFiscal" (string) Enum: "airPrint" "epson" "epsonFiscal" "posnetFiscal" "star" "zebra" Describes the manufacturer of the printer.
name	string The name of the printer.
required	Array of strings Describes the document types supported by the printer.
model required	string Describes model name of the printer.
macAddress	string Describes the Mac Address of a Epson receipt printer.
ipAddress required	string Describes the IP Address of a Epson/Posnet fiscal, Epson receipt or Zebra printer.
port required	number Describes the port of a Epson/Posnet fiscal printer.
serialNumber required	string Describes the serial number of a Epson/Posnet fiscal printer.
scalingFactor	number Describes a factor to scale to printing size for a document on Epson printers.
offsetTop	number Sets the offset from top for any print for a Zebra printer.
offsetLeft	number Sets the offset from top for any print for a Zebra printer.
interfaceType	string Describes the interface type of a Star printer.
identifier	string Describes the identifier of a Star printer.
paperWidth	number Sets the paper width being used at a Star printer.
networkName	string Describes the network name of an Airprint printer.
url	string Describes the url of an Airprint printer.

Responses

/api/v1/associate-app/store/%7BstoreId%7D/printers

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Response samples

• 201

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Get printer in a store

Retrieves information about the specified printer configuration available in a specified store.

Responses

/api/v1/associate-app/store/%7BstoreId%7D/printers/{$printerId}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Update printer

Updates the printer configuration for the specified printer.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

>= 3 properties

One of

>= 3 properties

required	"epsonFiscal" (string) or "posnetFiscal" (string) Enum: "airPrint" "epson" "epsonFiscal" "posnetFiscal" "star" "zebra" Describes the manufacturer of the printer.
name	string The name of the printer.
required	Array of strings Describes the document types supported by the printer.
model required	string Describes model name of the printer.
macAddress	string Describes the Mac Address of a Epson receipt printer.
ipAddress required	string Describes the IP Address of a Epson/Posnet fiscal, Epson receipt or Zebra printer.
port required	number Describes the port of a Epson/Posnet fiscal printer.
serialNumber required	string Describes the serial number of a Epson/Posnet fiscal printer.
scalingFactor	number Describes a factor to scale to printing size for a document on Epson printers.
offsetTop	number Sets the offset from top for any print for a Zebra printer.
offsetLeft	number Sets the offset from top for any print for a Zebra printer.
interfaceType	string Describes the interface type of a Star printer.
identifier	string Describes the identifier of a Star printer.
paperWidth	number Sets the paper width being used at a Star printer.
networkName	string Describes the network name of an Airprint printer.
url	string Describes the url of an Airprint printer.

Responses

/api/v1/associate-app/store/%7BstoreId%7D/printers/{$printerId}

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Delete printer

Deletes the printer with the specified ID.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

>= 3 properties

One of

>= 3 properties

required	"epsonFiscal" (string) or "posnetFiscal" (string) Enum: "airPrint" "epson" "epsonFiscal" "posnetFiscal" "star" "zebra" Describes the manufacturer of the printer.
name	string The name of the printer.
required	Array of strings Describes the document types supported by the printer.
model required	string Describes model name of the printer.
macAddress	string Describes the Mac Address of a Epson receipt printer.
ipAddress required	string Describes the IP Address of a Epson/Posnet fiscal, Epson receipt or Zebra printer.
port required	number Describes the port of a Epson/Posnet fiscal printer.
serialNumber required	string Describes the serial number of a Epson/Posnet fiscal printer.
scalingFactor	number Describes a factor to scale to printing size for a document on Epson printers.
offsetTop	number Sets the offset from top for any print for a Zebra printer.
offsetLeft	number Sets the offset from top for any print for a Zebra printer.
interfaceType	string Describes the interface type of a Star printer.
identifier	string Describes the identifier of a Star printer.
paperWidth	number Sets the paper width being used at a Star printer.
networkName	string Describes the network name of an Airprint printer.
url	string Describes the url of an Airprint printer.

Responses

/api/v1/associate-app/store/%7BstoreId%7D/printers/{$printerId}

Request samples

• Payload

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}

Response samples

• 200

Content type

application/json

Example

case 1case 2case 1

{

• "manufacturer": "epsonFiscal",
• "name": "string",
• "documentTypes": [

  • "salesReceipt"

  ],
• "model": "string",
• "macAddress": "string",
• "ipAddress": "string",
• "port": 0,
• "serialNumber": "string",
• "scalingFactor": 0,
• "offsetTop": 0,
• "offsetLeft": 0,
• "interfaceType": "string",
• "identifier": "string",
• "paperWidth": 0,
• "networkName": "string",
• "url": "string"

}