Skip to content
Shipping APIs
/
/
Printer mapping

Printer mapping

Request

printer mapping document

Security
bearerAuth
Headers
X-PB-Developer-Partner-Idstring

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-LocationIdstring

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-TransactionIdstring

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

Bodyapplication/jsonrequired
aliasstringrequired

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

Example:"rohit2"
serialNumberstringrequired

A Device Serial number.

Example:"AP-DP1LZH3-0x919e698164-dev"
printerNamestringrequired

The Printer name which is used for mapping.

Example:"Brother QL-1110NWB"
curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/printer/mapping \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string' \
  -H 'X-PB-TransactionId: string' \
  -d '{
    "alias": "rohit2",
    "serialNumber": "AP-DP1LZH3-0x919e698164-dev",
    "printerName": "Brother QL-1110NWB"
  }'

Responses

Successfully mapped printer

Bodyapplication/json
idstring

A Unique ID for the Printer mapper.

Example:"65cdce754189e0177c728c8c"
Response
{
  "id": "65cdce754189e0177c728c8c"
}