Update Package Fields via the Shiipp Warehouse API

The UpdatePackage endpoint allows you to modify individual fields on an existing package record. Only the fields you include in the request body are changed — omitted fields are left untouched. This makes the endpoint safe for partial updates without needing to re-submit the full package payload.

Endpoint

POST /api/UpdatePackage.php

Authentication: JWT Bearer token with package:edit permission required.

Authorization: Bearer <your_token>

Request Body

string

required

The UUID of the package you want to update. You can retrieve this from the List Packages endpoint.

string

Reassign the package to a different customer by providing their user code.

string

Update the first name associated with this package.

string

Update the last name associated with this package.

string

Update the shipper or sender name (e.g., "Amazon", "eBay Seller").

string

Update the description of the package contents (e.g., "Clothing - T-Shirts").

number

Update the package weight. Value must be provided in pounds (LBS).

number

Update the package length dimension, in inches.

number

Update the package width dimension, in inches.

number

Update the package height dimension, in inches.

string

Update the package type classification (e.g., "box", "envelope", "pallet").

string

Update or correct the carrier tracking number assigned to this package.

Example Requests

{
  "package_id": "pkg-uuid-here",
  "weight": 4.2,
  "description": "Clothing - T-Shirts"
}

{
  "package_id": "pkg-uuid-here",
  "user_code": "CUST099",
  "first_name": "Marcus",
  "last_name": "Brown"
}

curl -X POST https://app.shiipp.com/api/UpdatePackage.php \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "package_id": "pkg-uuid-here",
    "weight": 4.2,
    "description": "Clothing - T-Shirts"
  }'

Responses

Success — Fields Updated

Returned when one or more fields were changed successfully.

{
  "status": "success",
  "message": "Update successful.",
  "data": {
    "fields_updated": 2,
    "package_id": "pkg-uuid-here"
  }
}

string

"success" when the update was applied.

string

Confirmation message.

object

Show data fields

integer

The number of fields that were changed in this request.

string

The UUID of the package that was updated.

Success — No Changes Detected

Returned when the submitted values are identical to what’s already stored. No write occurs.

{
  "status": "success",
  "message": "No changes detected."
}

A "No changes detected." response is still an HTTP 200. This is not an error — it simply means the package already has the submitted values and no write was necessary.

Error Responses

HTTP Status	Cause
`400`	`package_id` is missing from the request body
`403`	The authenticated courier does not own this package
`404`	No package found matching the provided `package_id`

Post-Update Sync Behaviour

After any successful update, the package is automatically marked for re-synchronisation. If your integration monitors sync status, account for this behaviour when processing update events.

Role-Based Access

Courier role users can only update packages that belong to their own courier account. Attempting to update a package assigned to a different courier will return a 403 Forbidden error.

To update dimensions (length, width, height) and weight together in a single call, include all four fields in one request body. Each will be counted individually in fields_updated.

Overview

Prealerts

Packages

Customers

Manifests

Billing

Courier Settings

Update Package Fields via the Shiipp Warehouse API

Endpoint

Request Body

Example Requests

Responses

Success — Fields Updated

Success — No Changes Detected

Error Responses

Post-Update Sync Behaviour

Role-Based Access

​Endpoint

​Request Body

​Example Requests

​Responses

​Success — Fields Updated

​Success — No Changes Detected

​Error Responses

​Post-Update Sync Behaviour

​Role-Based Access

Endpoint

Request Body

Example Requests

Responses

Success — Fields Updated

Success — No Changes Detected

Error Responses

Post-Update Sync Behaviour

Role-Based Access