Banyan Technology LIVE Connect™

Create an EZ Rate Shipment

POST/api/v3/shipments

Create a EZ Rate shipment in Banyan.

An EZ rate shipment contains minimal information to simply obtain a quote. EZ Rates are typically used for a quick zip to zip rate.

To create an EZ Rate shipment, you will use the same endpoint as creating a full shipment and set the IsEzRate flag to true. This will turn off several of the validators on the required fields needed to create a full shipment.

An EZ Rate shipment must be converted to a full shipment using the Update a Shipment endpoint in order to book a quote.

Request

No schema defined

{
  "importAsStatus": "Quoted",
  "shouldRunRates": true,
  "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": 1,
        "packageType": "Pallets",
        "equipmentType": "Van-Standard Trailer",
        "weightUnitOfMeasurement": "LBS"
      }
    ],
    "handlingUnits": [
      {
        "packageType": "Pallets",
        "quantity": 1,
        "products": [
          {
            "packageType": "Boxes",
            "quantity": 10,
            "class": 200,
            "weight": 210,
            "weightUnitOfMeasurement": "LBS",
            "dimensions": {
              "unitOfMeasurement": "IN",
              "length": 42,
              "width": 42,
              "height": 56
            },
            "description": "TEST ONLY - PRODUCT 1 DESCRIPTION - TEST ONLY"
          }
        ]
      }
    ]
  }
}

Request samples

Responses

Created(201)

Bad Request(400)

HTTP Code: 201

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: 2 months ago