Get the Dispatch Confirmation PDF for an outwards consignment

​

Path Parameters

  • consignmentId
    Type: stringFormat: uuid
    required

Query Parameters

  • Orientation
    Type: enum

    The orientation of the PDF. Defaults to Portrait.

  • IncludeShipping
    Type: boolean

    Whether to include shipping information in the PDF, if any. Defaults to true.

  • IncludeMetrics
    Type: boolean

    Whether to include metrics in the PDF. Defaults to true.

  • IncludeNotes
    Type: boolean

    Whether to include notes in the PDF, if any. Defaults to true.

  • IncludePods
    Type: boolean

    Whether to include proof of delivery (POD) information in the PDF, if any. Defaults to true.

  • IncludeProductSummary
    Type: boolean

    Whether to include product summary information in the PDF. Defaults to false.

  • PrintOption.PrinterId
    Type: stringFormat: uuid

    The printer bridge warehouse printer id to be used for printing.

Responses

  • 200

    OK

Request Example for get/v1/consignments/{consignmentId}/dispatch-confirmation-pdf
curl 'https://api.consignlyhq.com/v1/consignments/123e4567-e89b-12d3-a456-426614174000/dispatch-confirmation-pdf?Orientation=Portrait%20%3D%201'
No Body

OK