Anticipated Breaking Changes: Order rate and label endpoints; Shipment label endpoints

API Announcements
,
1

Release Date

Changes Available to use: Wed Mar 7, 2018.

Estimated Dates:
Changes Available to use: Wed Mar 7, 2018.
Breaking Deprecation Date: Tue Mar 20, 2018. TBD, Support will continue for the time being.

Version Number

Exact Version TBD.
Post 1.481.0.

Breaking Changes

  • For the following label endpoints, we will be moving parcel specific keys to a list of package objects. This is in anticipation for allowing multiple package labels to be created for carriers that allow this.

    • Shipment label endpoints apiverson.ordoro.com
      • POST /shipment/{shipment_id}/label/generate
      • POST /shipment/{shipment_id}/label/ups
      • POST /shipment/{shipment_id}/label/endicia
      • POST /shipment/{shipment_id}/label/canada_post
      • POST /shipment/{shipment_id}/label/fedex
    • Order label endpoints apiverson.ordoro.com
      • POST /order/{order_number}/label/amazon
      • POST /order/{order_number}/label/canada_post
      • POST /order/{order_number}/label/dhl
      • POST /order/{order_number}/label/endicia
      • POST /order/{order_number}/label/fedex
      • POST /order/{order_number}/label/pitney
      • POST /order/{order_number}/label/ups
    • Order rate endpoints apiverson.ordoro.com
      • POST /order/{order_number}/rate/amazon
      • POST /order/{order_number}/rate/canada_post
      • POST /order/{order_number}/rate/dhl
      • POST /order/{order_number}/rate/endicia
      • POST /order/{order_number}/rate/fedex
      • POST /order/{order_number}/rate/pitney
      • POST /order/{order_number}/rate/ups

  • Previous Request Example

    •   {
  	"shipper_id": 1234,
  	"length": 8,
  	"width": 8,
  	"height": 3,
  	"box_shape": "Parcel"
  }

  • Updated Request Schema Example

    •   {
  	"shipper_id": {
  	  "type": "integer"
  	},
  	"packages": {
  	  "type": "array",
  	  "maxItems": 1,
  	  "items": {
  	    "type": "object",
  	    "properties": {
  	      "length": {
  	        "type": "number"
  	      }
  	      "width": {
  	        "type": "number"
  	      }
  	      "height": {
  	        "type": "number"
  	      }
  	      "box_shape": {
  	        "type": "string"
  	      }
  	    }
  	  }
  	}
  }

  • Updated Request Example

    •   {
  	"shipper_id": 1234,
  	"packages": [{
      	"length": 8,
      	"width": 8,
      	"height": 3,
      	"box_shape": "Parcel"
  	}]
  }

Other Changes

  • Order rate responses will all respond with the same response schema, no more nested info key: {"info": <rates>}.

Pending

  • Shipment rate endpoints will also see similar changes in the coming month, so please keep an eye out for API Announcements here as those dates and changes are announced.

Notes

2

Update: Support for dimension and other package related properties that are not nested within the packages property will continue on.

Announcement on deprecation: TBD