WRwritechoiceorg
returnApp

Book a return shipment label

Changed on

ADD ENDPOINT DESCRIPTION HERE

post/returnApp/book

Request

Request body

requestUUIDstring required

A unique identifier for the request. <br>Used for tracing and to prevent duplicate shipment bookings.

hashstring required

The hash that is used for booking return label.

referencestring required

A human readable reference for the request. <br>This will be included in the mail that is sent once the operation completes.

grossWeightKGnumber required

Weight of the return shipment.

heightMnumber

Height of the return shipment in meters.

lengthMnumber

Length of the return shipment in meters.

widthMnumber

Width of the return shipment in meters.

invoiceNumberstring

Optional invoice number for the shipment. Only required for royal mail.

invoiceDatestring

Optional invoice date for the shipment. Only required for royal mail.

Response

successful operation

status'OK' | 'ERROR'

Indicates whether the operation was successful or not.

messagestring

Optional additional information about the operation's result. <br>When the operation failed, this field includes more information about the error.

bookedShipmentIdinteger

ID of booked shipment

trackingNumberstring

The tracking number of the booked shipment.

trackingLinkstring

The tracking link of the booked shipment. Note that some carriers do not immediately recognize shipments after they have been created

labelUrlsstring[]

List of URLs where the labels can be downloaded.

documentUrlsstring[]

List of URLs where additional documents, such as export documents, can be downloaded.

Changes

  • 9dd8e967f8e9Revision changes
    • warning

      removed the request property //

    • warning

      removed the optional property from the response with the status