POST api/orders/{OrderNumber}/createReturnLabel/{ShipmentId}

Creates a return label for a shipped shipment

Request Information

URI Parameters

Name	Description	Type	Additional information
OrderNumber	Work order number	integer	Required
ShipmentId	Shipment number	integer	Required

Body Parameters

None.

Response Information

Resource Description

A structure returning data associated with the shipment.

ShipmentShippingResponse

Name	Description	Type	Additional information
ShippingInformation	An array of structures containing finalized data related to the package	Collection of ShipmentShippingInformation	None.
PickupSchedulingSuccess	If a pickup was requested, was the pickup successfully scheduled. (Null if not requested)	boolean	None.
PickupSchedulingErrorMessage	If the pickup scheduling was not successful, error message returned by the shipping service.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ShippingInformation": [
    {
      "PackageId": 1,
      "Label": "QEA=",
      "TrackingNumber": "sample string 2",
      "PackageDocuments": [
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:26:23.6751799-05:00"
        },
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:26:23.6751799-05:00"
        }
      ]
    },
    {
      "PackageId": 1,
      "Label": "QEA=",
      "TrackingNumber": "sample string 2",
      "PackageDocuments": [
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:26:23.6751799-05:00"
        },
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:26:23.6751799-05:00"
        }
      ]
    }
  ],
  "PickupSchedulingSuccess": true,
  "PickupSchedulingErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<ShipmentShippingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ShippingInformation>
    <ShipmentShippingInformation>
      <PackageId>1</PackageId>
      <Label>QEA=</Label>
      <TrackingNumber>sample string 2</TrackingNumber>
      <PackageDocuments>
        <ShipmentShippingPackageDocumentInformation>
          <DocumentPurpose>Unknown</DocumentPurpose>
          <DocumentImageType>Unknown</DocumentImageType>
          <Resolution>1</Resolution>
          <CopiesToPrint>2</CopiesToPrint>
          <DocumentBytes>QEA=</DocumentBytes>
          <PrintRequired>true</PrintRequired>
          <ElectronicallyUploadable>true</ElectronicallyUploadable>
          <ElectronicallyUploadedUtc>2024-12-25T09:26:23.6751799-05:00</ElectronicallyUploadedUtc>
        </ShipmentShippingPackageDocumentInformation>
        <ShipmentShippingPackageDocumentInformation>
          <DocumentPurpose>Unknown</DocumentPurpose>
          <DocumentImageType>Unknown</DocumentImageType>
          <Resolution>1</Resolution>
          <CopiesToPrint>2</CopiesToPrint>
          <DocumentBytes>QEA=</DocumentBytes>
          <PrintRequired>true</PrintRequired>
          <ElectronicallyUploadable>true</ElectronicallyUploadable>
          <ElectronicallyUploadedUtc>2024-12-25T09:26:23.6751799-05:00</ElectronicallyUploadedUtc>
        </ShipmentShippingPackageDocumentInformation>
      </PackageDocuments>
    </ShipmentShippingInformation>
    <ShipmentShippingInformation>
      <PackageId>1</PackageId>
      <Label>QEA=</Label>
      <TrackingNumber>sample string 2</TrackingNumber>
      <PackageDocuments>
        <ShipmentShippingPackageDocumentInformation>
          <DocumentPurpose>Unknown</DocumentPurpose>
          <DocumentImageType>Unknown</DocumentImageType>
          <Resolution>1</Resolution>
          <CopiesToPrint>2</CopiesToPrint>
          <DocumentBytes>QEA=</DocumentBytes>
          <PrintRequired>true</PrintRequired>
          <ElectronicallyUploadable>true</ElectronicallyUploadable>
          <ElectronicallyUploadedUtc>2024-12-25T09:26:23.6751799-05:00</ElectronicallyUploadedUtc>
        </ShipmentShippingPackageDocumentInformation>
        <ShipmentShippingPackageDocumentInformation>
          <DocumentPurpose>Unknown</DocumentPurpose>
          <DocumentImageType>Unknown</DocumentImageType>
          <Resolution>1</Resolution>
          <CopiesToPrint>2</CopiesToPrint>
          <DocumentBytes>QEA=</DocumentBytes>
          <PrintRequired>true</PrintRequired>
          <ElectronicallyUploadable>true</ElectronicallyUploadable>
          <ElectronicallyUploadedUtc>2024-12-25T09:26:23.6751799-05:00</ElectronicallyUploadedUtc>
        </ShipmentShippingPackageDocumentInformation>
      </PackageDocuments>
    </ShipmentShippingInformation>
  </ShippingInformation>
  <PickupSchedulingSuccess>true</PickupSchedulingSuccess>
  <PickupSchedulingErrorMessage>sample string 1</PickupSchedulingErrorMessage>
</ShipmentShippingResponse>