Printer mapping

printer mapping document

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-Id
string

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

X-PB-LocationId
string

This is the Location ID assigned as per the Developer's and Partner's parsed locations, to which all transactions will be billed.
Partner's location will be used for billing if it is configured, however, in case Partner's location is not given, then the Developer's location will be taken. Developer's location will be the default value.
Additionally, Developers and Partners can use carriers belong to this location only.

X-PB-TransactionId
string

A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.

Request Body schema: application/json
alias
required
string

Name of the printer connected (directly or via network) to a computer.

serialNumber
required
string

A Device Serial number.

printerName
required
string

The Printer name which is used for mapping.

Responses
201

Successfully mapped printer

401

The request could not be authorized.

post/api/v1/printer/mapping
Request samples
application/json
{
  • "alias": "rohit2",
  • "serialNumber": "AP-DP1LZH3-0x919e698164-dev",
  • "printerName": "Brother QL-1110NWB"
}
Response samples
application/json
{
  • "id": "65cdce754189e0177c728c8c"
}