Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
PrintService

CreateReturnShippingLabelsPDF

Creates a PDF file of return shipping labels for a single order <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/PrintService/CreateReturnShippingLabelsPDF

Request body

IDsstring[]

A list containing the (single) pkOrderId of the order to print return labels for

returnPostalServiceNamestring

Name of the postal service to use. If null then specified in settings or same as the outbound shipment

Example request

{
  "IDs": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "orderItemIdsAndQuantities": [
    {
      "Key": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Response

OK

URLstring

URL to PDF file

IdsProcessedstring[]

List of processed order or item IDs

ProcessedIdsobject
PageCountinteger
PrintErrorsstring[]

List of OrderId / Error message

Example response

{
  "KeyedError": [
    {
      "Id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "IdsProcessed": [
    "00000000-0000-0000-0000-000000000000"
  ]
}