Sign in

v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Return Envelopes

Fill Test Return Envelope Order

Fills the return envelope order by orderID for the return envelope by id. This is only available in test mode and can be used to simulate how a live order would be filled.

Note: this will fail with a return_envelope_order_cannot_fill_error if the order's status is not placed.

post/print-mail/v1/return_envelopes/{id}/orders/{orderID}/fills

Path parameters

idstring required

The ID of the return envelope.

orderIDstring required

The ID of the return envelope order to fill.

Response

The filled return envelope order.

idstring required

A unique ID prefixed with return_envelope_order_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.