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"
    }
  ]
}

Changes

Changed in 6 of the 13 revisions of this API.5616

Mar 2, 2026fa53dd949b8e1See the full diff
- ○
  endpoint added
  endpoint-added
Oct 7, 20253b410dd1cc4b1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
May 28, 20245be88c3f42d31See the full diff
- ○
  endpoint added
  endpoint-added
May 28, 2024b02ec7e89f321See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Apr 22, 202408cd9cfa14dd162See the full diff
- ▲
  added required request body
  request-body-added-required
- ●
  deleted the query request parameter carrier_shipment_id
  request-parameter-removed
- ●
  deleted the query request parameter no_refresh
  request-parameter-removed
- ●
  deleted the query request parameter order_number
  request-parameter-removed
- ●
  deleted the query request parameter shipment_id
  request-parameter-removed
- ●
  deleted the query request parameter store_id
  request-parameter-removed
- ●
  deleted the query request parameter tracking_number
  request-parameter-removed
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Apr 19, 202446ceda528000212See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ○
  api operation id post_shipping_restore_inventory removed and replaced with
  api-operation-id-removed
- ○
  added the new optional query request parameter carrier_shipment_id
  new-optional-request-parameter
- ○
  added the new optional query request parameter no_refresh
  new-optional-request-parameter
- ○
  added the new optional query request parameter order_number
  new-optional-request-parameter
- ○
  added the new optional query request parameter shipment_id
  new-optional-request-parameter
- ○
  added the new optional query request parameter store_id
  new-optional-request-parameter
- ○
  added the new optional query request parameter tracking_number
  new-optional-request-parameter
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history