cancelShipment: Cancel a shipping order

With the cancelShipment call you can cancel a shipping order.

💡

Please note, that once a shipping order has been completed (i.e.,doCompletion = true), it becomes immutable.

Any data correction is not possible through the interface after completion. Therefore, to make changes, you must first cancel the completed shipping order using the cancelShipment call and subsequently retransmit the data with the createShipment call.

❗️

It's important to highlight, that the cancelShipment call sets the shipping order status to canceled; the order itself will not be deleted.

This ensures proper record-keeping while effectively canceling the order.

{
  ...
  "shipmentReference": {
    "referenceNumber1": "1001"
  }
}

...
<shipmentReference>
   <referenceNumber1>1001</referenceNumber1>
</shipmentReference>
...

deleteItem: Delete an item

The deleteItem call allows you to effectively remove an existing item from a shipping order.

{
  ...
  "shipmentItemReference": {
    "shipmentReference": {
      "referenceNumber1": "1001"
    },
    "itemTransactionId": "YOUR_TRANSACTION_ID"
  }
}

...
<shipmentItemReference>
   <shipmentReference>
      <referenceNumber1>1001</referenceNumber1>
   </shipmentReference>
   <itemTransactionId>YOUR_TRANSACTION_ID</itemTransactionId>
</shipmentItemReference>

deletePackage: Delete a package

The deletePackage call provides a straightforward method to delete a package from your shipping order.

{
  ...
  "packageReference": {
    "shipmentReference": {
      "referenceNumber1": "1001"
    },
    "packageTransactionId": "YOUR_TRANSACTION_ID"
  }
}

...
<packageReference>
   <shipmentReference>
      <referenceNumber1>1001</referenceNumber1>
   </shipmentReference>
   <packageTransactionId>YOUR_TRANSACTION_ID</packageTransactionId>
</packageReference>

deletePickup: Delete a pickup

The deletePickup enables you to delete an existing pickup. When this call is made, all shipments associated with the pickup are removed, and they must be assigned to a new pickup using another createPickup call.

💡

It's important to note, that a pickup that has already been closed (i.e., doManifest = true) cannot be deleted anymore.

{
  ...
  "pickupReference": {
      "referenceNumber1": "1001"
    }
}

...
<pickupReference>
  <referenceNumber1>1001</referenceNumber1>
</pickupReference>