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

The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed. If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing.

Requirement Rules

  • The X-PB-LocationId header is optional when the shipment origin country code matches the enterprise's default address country code.
  • The X-PB-LocationId header is required when the shipment origin country code differs from the enterprise's default address country code.
  • If the header is required but not provided, the API will return a validation error "invalid origin countryCode".
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"
}