Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

PrintService /CreateReturnShippingLabelsPDF

Allows 150 calls per minute

Response: CreatePDFResult



Creates a PDF file of return shipping labels for a single order

Parameters

NameTypeDescription
IDsList<Guid>A list containing the (single) pkOrderId of the order to print return labels for
orderItemIdsAndQuantitiesList<KeyValuePair>A list of the order item IDs and quantities to include. If empty then same as the outbound shipment
returnPostalServiceNameStringName of the postal service to use. If null then specified in settings or same as the outbound shipment

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/PrintService/CreateReturnShippingLabelsPDF

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

IDs=[
  "aea73ccc-b339-4bd8-900f-5ea3475987de"
]&orderItemIdsAndQuantities=[
  {
    "Key": "ae532e25-a226-4100-b841-f50d080228a4",
    "Value": 2
  }
]&returnPostalServiceName=sample string 1

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "KeyedError": [
    {
      "TemplateType": "sample string 1",
      "Id": "b37f5981-e305-496a-8378-455bfb6b0210",
      "Error": "sample string 3",
      "Tags": [
        {
          "Tag": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "URL": "sample string 1",
  "IdsProcessed": [
    "3f603d24-60c7-493b-a179-49ca14224954"
  ],
  "ProcessedIds": {
    "sample string 1": [
      "acd95c5a-a2d3-4bd6-8d17-96e2b9163132"
    ]
  },
  "PageCount": 2,
  "PrintErrors": [
    "sample string 1"
  ]
}