Printer Bridges

Printer Bridge enables remote printing to warehouse printers without requiring direct network access. A lightweight bridge application runs on a computer at the warehouse site, connecting local printers to the Consignly cloud.

Print Job Lifecycle

When you submit a print job via the API, it progresses through these statuses:

Value	Status	Description
`1`	Pending	Job submitted, waiting to be processed
`2`	InProgress	Job currently printing
`3`	Success	Job printed successfully
`4`	Failed	Job failed to print
`5`	Cancelled	Job was cancelled

Endpoints Overview

Method	Endpoint	Description
`GET`	`/v1/printer-bridges/printer/options`	Get printer options

Get Printer Options

Retrieve a collection of printer bridge warehouse printer options.

Endpoint: GET /v1/printer-bridges/printer/options

Query Parameters

Parameter	Type	Required	Description
`SearchText`	string	No	Filter by printer name (matches all or part of the name)
`WarehouseId`	uuid	No	Filter by warehouse ID
`PrintType`	integer	No	Filter by printer type (see Printer Type Values)

Printer Status Values

Value	Status	Description
`1`	Online	Printer is online and available
`2`	Offline	Printer is offline

Printer Type Values

Value	Type	Description
`1`	Label	Label printer
`2`	Document	Document printer

Request Example

curl -X GET "https://api.consignlyhq.com/v1/printer-bridges/printer/options?WarehouseId=550e8400-e29b-41d4-a716-446655449901&PrintType=1" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "printers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655449900",
      "name": "Warehouse Label Printer 1",
      "type": 1,
      "status": 1,
      "warehouseId": "550e8400-e29b-41d4-a716-446655449901"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449902",
      "name": "Office Document Printer",
      "type": 2,
      "status": 1,
      "warehouseId": "550e8400-e29b-41d4-a716-446655449901"
    }
  ]
}

Response Fields

Field	Type	Description
`id`	uuid	Printer ID
`name`	string	Printer name
`type`	integer	Type of printer (see Printer Type Values)
`status`	integer	Printer status (see Printer Status Values)
`warehouseId`	uuid	Associated warehouse ID

Using Printer IDs

Printer IDs are used when printing documents via the API:

Print Consignment Detail PDF

curl -X POST "https://api.consignlyhq.com/v1/consignments/{consignmentId}/detail-pdf/print" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "orientation": 0,
    "includeShipping": true,
    "printOption": {
      "printerId": "550e8400-e29b-41d4-a716-446655449902"
    }
  }'

Print Picking List

curl -X POST "https://api.consignlyhq.com/v1/consignments/{consignmentId}/picking-list-pdf/print" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sortBy": 1,
    "printOption": {
      "printerId": "550e8400-e29b-41d4-a716-446655449902"
    }
  }'

Print DG Declaration

curl -X POST "https://api.consignlyhq.com/v1/consignments/{consignmentId}/dg-declaration-pdf/print" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "printerId": "550e8400-e29b-41d4-a716-446655449902"
  }'

Printer Selection Guidelines

Document Type	Recommended Printer Type
Consignment Detail PDF	Document
Dispatch Confirmation	Document
Receipt Confirmation	Document
Picking List	Document
DG Declaration	Document
Product Labels	Label
Pallet Labels	Label

Error Handling

When printing fails:

Error	Cause	Resolution
Printer offline	Printer status is Offline	Check printer connection
Printer not found	Invalid printer ID	Verify printer ID
Wrong printer type	Using label printer for documents	Select appropriate printer type

Consignments - Document printing endpoints
Warehouses - Warehouse information

Partner Schedules

Product Attributes