Update a Shipment

Updates a shipment in Banyan.

This method can be used to change the details on an existing shipment, or convert an EZ Rate shipment into a full shipment.

Reference the table below, as well as the supplied examples to see the different ways to use this endpoint.

Attribute	Type	Description
`WaitForRates`	bool	Defaults to true. Returns when rating engine is complete.Set to false to return a response immediately.
`IsEzRate`	bool	Defaults to false. Create the shipment as an EZ Rate with minimal data.
`loadAccessorials`	array	For any accessorials only the description or the abbreviation is needed. See /StaticData/Accessorials endpoint for valid values.
`pullMarketRates`	bool	Defaults to false. Pulls the market rates for this shipment.
`HandlingUnits`	array	The handling units containing the products. For shipments that cannot utilize handling units, supply a single handling unit with 0 for quantity, and None for package type, and the shipment will not create handling units.
`VendorId`	string	If vendor id is supplied, the system will look up the vendor location and use that data instead of what is in the request. If `DistributionCenterReferenceNumber` is supplied this can further filter data for vendors with multiple locations.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "isEzRate": true,
    "waitForRates": false,
    "shipmentData": {
        "shipType": "ThirdParty",
        "payType": "Prepaid",
        "shipperLocation": {
            "address": {
                "city": "ALBANY",
                "stateOrProvince": "NY",
                "zipCode": "12204",
                "country": "United States"
            }
        },
        "consigneeLocation": {
            "address": {
                "city": "MIAMI",
                "stateOrProvince": "FL",
                "zipCode": "33156",
                "country": "United States"
            }
        },
        "shipmentServices": [
            {
                "serviceMode": "LTL",
                "quantity": 2,
                "packageType": "Pallets",
                "equipmentType": "Van-Standard Trailer",
                "weightUnitOfMeasurement": "LBS"
            }
        ],
        "handlingUnits": [
            {
                "packageType": "Pallets",
                "quantity": 2,
                "products": [
                    {
                        "packageType": "Boxes",
                        "quantity": 20,
                        "class": 200,
                        "weight": 400,
                        "weightUnitOfMeasurement": "LBS",
                        "dimensions": {
                            "unitOfMeasurement": "IN",
                            "length": 42,
                            "width": 42,
                            "height": 56
                        },
                        "description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
                    }
                ]
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Updates a shipment in Banyan.#

This method can be used to change the details on an existing shipment, or convert an EZ Rate shipment into a full shipment.#

Reference the table below, as well as the supplied examples to see the different ways to use this endpoint.#

Request

Request Code Samples

Responses

Updates a shipment in Banyan.

This method can be used to change the details on an existing shipment, or convert an EZ Rate shipment into a full shipment.

Reference the table below, as well as the supplied examples to see the different ways to use this endpoint.