Cancel Shipment by Order ID and Shipment ID

curl -X POST https://api.shipbob.com/2026-01/order/orderId/shipment/shipmentId:cancel \
     -H "Authorization: Bearer <token>"

{
  "actual_fulfillment_date": "2019-08-24T14:15:22Z",
  "created_date": "2019-08-24T14:15:22Z",
  "delivery_date": "2019-08-24T14:15:22Z",
  "estimated_fulfillment_date": "2019-08-24T14:15:22Z",
  "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
  "gift_message": "string",
  "id": 0,
  "insurance_value": 0,
  "invoice_amount": 0,
  "invoice_currency_code": "string",
  "is_tracking_uploaded": true,
  "last_tracking_update_at": "2019-08-24T14:15:22Z",
  "last_update_at": "2019-08-24T14:15:22Z",
  "location": {
    "id": 0,
    "name": "Cicero (IL)"
  },
  "measurements": {
    "depth_in": 0,
    "length_in": 0,
    "total_weight_oz": 0,
    "width_in": 0
  },
  "order_id": 0,
  "package_material_type": "Unknown",
  "parent_cartons": [
    {
      "barcode": "string",
      "cartons": [
        {
          "barcode": "string",
          "carton_details": [
            {
              "products": [
                {
                  "id": 0,
                  "inventory_items": [
                    {
                      "expiration_date": "2019-08-24T14:15:22Z",
                      "id": 0,
                      "is_dangerous_goods": true,
                      "lot": "22222",
                      "name": "Medium Blue T-Shirt",
                      "quantity": 0,
                      "quantity_committed": 0,
                      "serial_numbers": [
                        "string"
                      ]
                    }
                  ],
                  "name": "Medium Blue T-Shirt",
                  "reference_id": "TShirtBlueM",
                  "sku": "TShirtBlueM"
                }
              ]
            }
          ],
          "id": 0,
          "measurements": {
            "depth_in": 0.1,
            "length_in": 0.1,
            "total_weight_oz": 0.1,
            "width_in": 0.1
          },
          "type": "Box or pallet"
        }
      ],
      "measurements": {
        "depth_in": 0.1,
        "length_in": 0.1,
        "total_weight_oz": 0.1,
        "width_in": 0.1
      },
      "type": "Box or pallet"
    }
  ],
  "products": [
    {
      "id": 0,
      "inventory_items": [
        {
          "expiration_date": "2019-08-24T14:15:22Z",
          "id": 0,
          "is_dangerous_goods": true,
          "lot": "22222",
          "name": "Medium Blue T-Shirt",
          "quantity": 0,
          "quantity_committed": 0,
          "serial_numbers": [
            "string"
          ]
        }
      ],
      "name": "Medium Blue T-Shirt",
      "reference_id": "TShirtBlueM",
      "sku": "TShirtBlueM"
    }
  ],
  "recipient": {
    "address": {
      "address1": "100 Nowhere Blvd",
      "address2": "Suite 100",
      "city": "Gotham City",
      "company_name": "Wayne Enterprises",
      "country": "US",
      "state": "NJ",
      "zip_code": "07093"
    },
    "email": "john@example.com",
    "full_name": "John Doe",
    "name": "John Doe",
    "phone_number": "555-555-5555"
  },
  "reference_id": "string",
  "require_signature": true,
  "ship_option": "Standard",
  "status": "None",
  "status_details": [
    {
      "description": "string",
      "exception_fulfillment_center_id": 0,
      "extra_information": {
        "validation_messages": [
          "string"
        ]
      },
      "id": 0,
      "inventory_id": 0,
      "name": "string"
    }
  ],
  "tracking": {
    "bol": "string",
    "carrier": "USPS",
    "carrier_service": "Priority",
    "pro_number": "string",
    "scac": "string",
    "shipping_date": "2019-08-24T14:15:22Z",
    "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
    "tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
  }
}

Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

shipmentIdstringRequiredformat: "int32"

The shipment id to get

orderIdstringRequired

Response

Success

object

Authentication

Path parameters

Response

Errors