Sign in
shipments

Restore a shipment

Changed on

Restores a shipment that is on hold. The shipment returns to the pending status and its hold_until_date is cleared. No request body is required.

The shipment must currently be on hold. Restoring a shipment in any other status returns a 400 response.

To restore up to 500 shipments in one request, use Restore shipments.

put/v1/shipments/{shipment_id}/restore

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/shipments/{shipment_id}/restore
  • Auth: API key in header API-Key

Response

The request was a success.

shipment_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

Example response

{
  "shipment_id": "se-28529731"
}

Changes

  • 020f57d6f5b8Revision changes
    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

  • 87db9f1b6ab1Revision changes
    • ○

      endpoint added