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

Ships a shipment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderNumber

Work order number

integer

Required

ShipmentId

Shipment number

integer

Required

Body Parameters

Structure containing data received from shipment validation

ShipmentShippingRequest
NameDescriptionTypeAdditional information
ValidationToken

The validation token returned by the shipment validation call.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ValidationToken": "sample string 1"
}

application/xml, text/xml

Sample:
<ShipmentShippingRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ValidationToken>sample string 1</ValidationToken>
</ShipmentShippingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A structure returning data associated with the shipment.

ShipmentShippingResponse
NameDescriptionTypeAdditional 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:14:35.0750585-05:00"
        },
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:14:35.0750585-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:14:35.0750585-05:00"
        },
        {
          "DocumentPurpose": 0,
          "DocumentImageType": 0,
          "Resolution": 1,
          "CopiesToPrint": 2,
          "DocumentBytes": "QEA=",
          "PrintRequired": true,
          "ElectronicallyUploadable": true,
          "ElectronicallyUploadedUtc": "2024-12-25T09:14:35.0750585-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:14:35.0750585-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:14:35.0750585-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:14:35.0750585-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:14:35.0750585-05:00</ElectronicallyUploadedUtc>
        </ShipmentShippingPackageDocumentInformation>
      </PackageDocuments>
    </ShipmentShippingInformation>
  </ShippingInformation>
  <PickupSchedulingSuccess>true</PickupSchedulingSuccess>
  <PickupSchedulingErrorMessage>sample string 1</PickupSchedulingErrorMessage>
</ShipmentShippingResponse>