The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.

RequestedDocumentSpecification

interface RequestedDocumentSpecification {
    dpi?: number;
    format: DocumentFormat;
    needFileJoining: boolean;
    pageLayout?: string;
    requestedDocumentTypes: DocumentType[];
    size: DocumentSize;
}

Properties

dpi?: number

The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.

RequestedDocumentSpecification

RequestedDocumentSpecification

needFileJoining: boolean

When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.

RequestedDocumentSpecification

pageLayout?: string

Indicates the position of the label on the paper. Should be the same value as returned in getRates response.

RequestedDocumentSpecification

requestedDocumentTypes: DocumentType[]

A list of the document types requested.

RequestedDocumentSpecification

RequestedDocumentSpecification