Skip to main content
PUT
/
1.0
/
shipment
/
{shipmentId}
Update a Shipment
curl --request PUT \
  --url https://api.shipbob.com/1.0/shipment/{shipmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_tracking_uploaded": true
}
'
[
  {
    "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": "[email protected]",
      "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"
    }
  }
]
API 1.0 is deprecated and will be sunset on July 31, 2026. Please migrate to the latest API version. See our Versioning Policy for details.

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>

Channel Id for Operation

Path Parameters

​
shipmentId
string<int32>
required

The Shipment id to be updated

Body

application/json

Shipment Information to be updated

Model for Updating multiple shipments of the same Order

​
is_tracking_uploaded
boolean

Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated.

Response

Success

Information about a shipment

​
actual_fulfillment_date
string<date-time> | null

The datetime of ShipBob’s completion of the fulfillment operation as promised. Currently, this means the shipment has been picked, packed, and label has been printed.

​
created_date
string<date-time>

Date this shipment was created

​
delivery_date
string<date-time> | null

The datetime of Shipment delivered to customer.

​
estimated_fulfillment_date
string<date-time> | null

The datetime of ShipBob’s commitment for completing the shipment and handing to the carrier for delivery.

​
estimated_fulfillment_date_status
enum<string>
Available options:
AwaitingInventoryAllocation,
AwaitingReset,
Unavailable,
PendingOnTime,
FulfilledOnTime,
PendingLate,
FulfilledLate
​
gift_message
string | null

Gift message associated with the shipment

Maximum string length: 500
​
id
integer<int32>

Unique id of the shipment

​
insurance_value
number<currency> | null

Monetary amount that this shipment was insured for

​
invoice_amount
number<currency> | null

Monetary amount that was invoiced for this shipment

​
invoice_currency_code
string | null
​
is_tracking_uploaded
boolean

Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated.

​
last_tracking_update_at
string<date-time> | null

Timestamp for the last time this shipment had a tracking update

​
last_update_at
string<date-time> | null

Date this shipment was last updated

​
location
object

Information about a fulfillment center that a shipment can belong to

​
measurements
object

Measurements of a shipment

​
order_id
integer<int32>

Id of the order this shipment belongs to

​
package_material_type
enum<string>
Available options:
Unknown,
Box,
BubbleMailer,
PolyMailer,
FragileBox,
PosterTube,
Custom,
Bookfold,
OwnContainer,
Undefined
​
parent_cartons
object[] | null

Carton information for this shipment

​
products
object[] | null

Information about the products contained in this shipment

​
recipient
object

Information about the recipient of a shipment

​
reference_id
string | null

Client-defined external unique id of the order this shipment belongs to

​
require_signature
boolean

If a shipment requires signature

​
ship_option
string | null

Name of the shipping option used for this shipment

Example:

"Standard"

​
status
enum<string>
Available options:
None,
Processing,
Completed,
Exception,
OnHold,
Cancelled,
CleanSweeped,
LabeledCreated,
ImportReview
​
status_details
object[] | null

Additional details about the shipment status

​
tracking
object

Tracking information for a shipment