Cancel one Shipment by Shipment Id

POST

shipment

{shipmentId}

cancel

curl --request POST \
  --url https://api.shipbob.com/2.0/shipment/{shipmentId}/cancel \
  --header 'Authorization: <api-key>'

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

Authorizations

Authorization

string

header

required

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Headers

shipbob_channel_id

string

Channel Id for Operation

Path Parameters

shipmentId

string

required

The shipment id to get

Response

200

application/json

Success

Information about a shipment

actual_fulfillment_date

string | 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 this shipment was created

delivery_date

string | null

The datetime of Shipment delivered to customer.

estimated_fulfillment_date

string | 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 length: 500

integer

Unique id of the shipment

insurance_value

number | null

Monetary amount that this shipment was insured for

invoice_amount

number | 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 | null

Timestamp for the last time this shipment had a tracking update

last_update_at

string | 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

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

parent_cartons.barcode

string | null

Barcode assigned to this carton

parent_cartons.cartons

object[] | null

Cartons packed inside this parent container

parent_cartons.measurements

object

Measurements of a carton

parent_cartons.type

string | null

Type of this carton container

Example:

"Box or pallet"

products

object[] | null

Information about the products contained in this shipment

Information about a store product belonging to a 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

Information about a shipment

actual_fulfillment_date

string | 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 this shipment was created

delivery_date

string | null

The datetime of Shipment delivered to customer.

estimated_fulfillment_date

string | 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 length: 500

integer

Unique id of the shipment

insurance_value

number | null

Monetary amount that this shipment was insured for

invoice_amount

number | 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 | null

Timestamp for the last time this shipment had a tracking update

last_update_at

string | 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

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

parent_cartons.barcode

string | null

Barcode assigned to this carton

parent_cartons.cartons

object[] | null

Cartons packed inside this parent container

parent_cartons.measurements

object

Measurements of a carton

parent_cartons.type

string | null

Type of this carton container

Example:

"Box or pallet"

products

object[] | null

Information about the products contained in this shipment

Information about a store product belonging to a 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

Information about a shipment

actual_fulfillment_date

string | 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 this shipment was created

delivery_date

string | null

The datetime of Shipment delivered to customer.

estimated_fulfillment_date

string | 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 length: 500

integer

Unique id of the shipment

insurance_value

number | null

Monetary amount that this shipment was insured for

invoice_amount

number | 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 | null

Timestamp for the last time this shipment had a tracking update

last_update_at

string | 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

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

parent_cartons.barcode

string | null

Barcode assigned to this carton

parent_cartons.cartons

object[] | null

Cartons packed inside this parent container

parent_cartons.measurements

object

Measurements of a carton

parent_cartons.type

string | null

Type of this carton container

Example:

"Box or pallet"

products

object[] | null

Information about the products contained in this shipment

Information about a store product belonging to a 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

store_order_id

string | null

Unique store order id of the shipment

Was this page helpful?

Get Order Store Json

curl --request POST \
  --url https://api.shipbob.com/2.0/shipment/{shipmentId}/cancel \
  --header 'Authorization: <api-key>'

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

Webhooks

Orders

Locations

Receiving

Returns

Products

Channels

Inventory

Cancel one Shipment by Shipment Id

Authorizations

Headers

Path Parameters

Response