Shipping - Void

Void a shipment, cancelling the shipping label and optionally restoring inventory.

DELETE /s/ship/shipping/void

Shipping - Void

cURL

curl --request DELETE \
  --url https://app.skulabs.com/s/ship/shipping/void \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "507f1f77bcf86cd799439011",
  "order_number": "<string>",
  "shipment_id": "507f1f77bcf86cd799439011",
  "tracking_number": "<string>",
  "no_refresh": true,
  "carrier_shipment_id": "<string>",
  "force_void": true
}
'

200

{
  "_id": "507f1f77bcf86cd799439011",
  "shipments": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "request": {
        "parcel": {
          "length": 123,
          "width": 123,
          "height": 123,
          "weight": 123,
          "weight_unit": "oz",
          "dimensions_unit": "in",
          "template": "<string>",
          "template_carrier": "<string>"
        },
        "address": {
          "name": "<string>",
          "company": "<string>",
          "street": "<string>",
          "street_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "US",
          "phone": "<string>",
          "email": "<string>",
          "residential": true
        },
        "_id": "507f1f77bcf86cd799439011",
        "store_id": "507f1f77bcf86cd799439011",
        "origin_address": {
          "name": "<string>",
          "company": "<string>",
          "street": "<string>",
          "street_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "US",
          "phone": "<string>",
          "email": "<string>",
          "residential": true
        },
        "return_address": {
          "name": "<string>",
          "company": "<string>",
          "street": "<string>",
          "street_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>",
          "country": "US",
          "phone": "<string>",
          "email": "<string>",
          "residential": true
        },
        "rate": {
          "service": "<string>",
          "service_code": "<string>",
          "carrier_account": {
            "_id": "507f1f77bcf86cd799439011",
            "name": "<string>"
          }
        },
        "carrier_account_ids": [
          "<string>"
        ],
        "order_items": [
          {
            "sku": "<string>",
            "item_id": "507f1f77bcf86cd799439011",
            "quantity": 123,
            "location_id": "507f1f77bcf86cd799439011"
          }
        ],
        "customs_items": [
          {
            "description": "<string>",
            "quantity": 123,
            "value": 123,
            "weight": 123,
            "hs_tariff_number": "<string>",
            "origin_country": "US"
          }
        ],
        "signature_confirmation": true,
        "insurance_amount": 123,
        "insurance_type": "<string>",
        "return_label": true,
        "reference_1": "<string>",
        "reference_2": "<string>",
        "format": "<string>",
        "currency": "USD",
        "origin": "507f1f77bcf86cd799439011",
        "shipping_date": "2025-01-15",
        "should_deduct": true
      },
      "response": {
        "provider": "<string>",
        "service": "<string>",
        "tracking_number": "<string>",
        "shipment_id": "<string>",
        "amount": 123,
        "label_url": "<string>",
        "fees": 123
      },
      "time": "2025-01-15T12:00:00.000Z",
      "state": "shipped",
      "manual_shipment": true,
      "deducted": true
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

store_id · string · required

Store ID

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number

shipment_id · string

SKULabs shipment ID

Example:

"507f1f77bcf86cd799439011"

tracking_number · string

Tracking number to identify the shipment

no_refresh · boolean

Skip cache refresh after voiding

carrier_shipment_id · string

Carrier-specific shipment ID

force_void · boolean

Force void even if carrier void fails

Response

200

application/json

Shipment voided and inventory restored (returns updated order shipments)

_id · string

Order ID

Example:

"507f1f77bcf86cd799439011"

shipments · object[]

Order shipments

Show child attributes