Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
shipping

Shipping - Restore Inventory

Restore inventory that was previously deducted when a shipment was created.

post/s/ship/shipping/restore_inventory

Request body

store_idstring required

Store ID

order_numberstring required

Order number

shipment_idstring

SKULabs shipment ID

tracking_numberstring

Tracking number to identify the shipment

no_refreshboolean

Skip cache refresh after restoring

carrier_shipment_idstring

Carrier-specific shipment ID

Example request

{
  "store_id": "507f1f77bcf86cd799439011",
  "shipment_id": "507f1f77bcf86cd799439011"
}

Response

Inventory restored and returns updated order shipments

_idstring

Order ID

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "shipments": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "request": {
        "_id": "507f1f77bcf86cd799439011",
        "store_id": "507f1f77bcf86cd799439011",
        "address": {
          "country": "US"
        },
        "origin_address": {
          "country": "US"
        },
        "return_address": {
          "country": "US"
        },
        "rate": {
          "carrier_account": {
            "_id": "507f1f77bcf86cd799439011"
          }
        },
        "order_items": [
          {
            "item_id": "507f1f77bcf86cd799439011",
            "location_id": "507f1f77bcf86cd799439011"
          }
        ],
        "customs_items": [
          {
            "origin_country": "US"
          }
        ],
        "currency": "USD",
        "origin": "507f1f77bcf86cd799439011",
        "shipping_date": "2025-01-15"
      },
      "time": "2025-01-15T12:00:00.000Z"
    }
  ]
}