Request Consignment Label

Request consignment labels for one or more shipments to be dispatched from the warehouse.

Direction WMS → External System

HTTP Method POST

Path /consignment/request

Request Body

[
  "SHP-OUT-2024-001234",
  "SHP-OUT-2024-001235",
  "SHP-OUT-2024-001236"
]

Response Codes

200: Consignment labels generated

400: Invalid shipment numbers

401: Authentication required

404: One or more shipments not found

422: Shipments not ready for consignment

Success Response (200)

{
  "success": true,
  "message": "Consignment labels successfully generated",
  "consignmentId": "CONS-2024-567890",
  "generatedAt": "2024-01-20T17:30:00Z",
  "totalShipments": 3,
  "labels": [
    {
      "shipmentNumber": "SHP-OUT-2024-001234",
      "labelId": "LBL-001234-001",
      "trackingNumber": "1Z999AA1234567890",
      "labelUrl": "https://labels.wms.example.com/LBL-001234-001.pdf",
      "carrier": "UPS",
      "service": "GROUND"
    },
    {
      "shipmentNumber": "SHP-OUT-2024-001235",
      "labelId": "LBL-001235-001",
      "trackingNumber": "1Z999AA1234567891",
      "labelUrl": "https://labels.wms.example.com/LBL-001235-001.pdf",
      "carrier": "UPS",
      "service": "GROUND"
    },
    {
      "shipmentNumber": "SHP-OUT-2024-001236",
      "labelId": "LBL-001236-001",
      "trackingNumber": "1Z999AA1234567892",
      "labelUrl": "https://labels.wms.example.com/LBL-001236-001.pdf",
      "carrier": "UPS",
      "service": "NEXT_DAY"
    }
  ],
  "manifestRequired": true,
  "manifestDeadline": "2024-01-21T17:00:00Z"
}

Error Response (404)

{
  "success": false,
  "error": "SHIPMENTS_NOT_FOUND",
  "message": "One or more shipments not found",
  "notFound": [
    "SHP-OUT-2024-001235"
  ],
  "found": [
    "SHP-OUT-2024-001234",
    "SHP-OUT-2024-001236"
  ]
}

Error Response (422)

{
  "success": false,
  "error": "SHIPMENTS_NOT_READY",
  "message": "One or more shipments are not ready for consignment",
  "invalidShipments": [
    {
      "shipmentNumber": "SHP-OUT-2024-001234",
      "currentStatus": "PICKING",
      "requiredStatus": "READY_FOR_DISPATCH"
    }
  ]
}

Shipment Status Requirements

To request a consignment label, shipments must be in one of these statuses:

• READY_FOR_DISPATCH - Fully picked and packed
• STAGED - Ready and waiting at dispatch area
• MANIFEST_PENDING - Awaiting manifest creation

Label Formats

Labels are generated in PDF format and include:

• Carrier tracking barcode
• Destination address
• Return address
• Service level information
• Package weight and dimensions
• Special handling instructions (if applicable)