What changed in the API

echoGlobalLogistics and echs are new provider and providerScac values on Create a quote rates. Echo rates used to come back as partner.

Create a quote can answer 429 with a Retry-After header. An organization can create 100 quotes a minute.

After an organization creates 500 quotes, the limit drops to 10 a minute until four hours after the first quote in that window.

notifyBeforeArrival is a new delivery-only value for accessorials on Create a quote, for users Mothership has enabled it for.

Quote and shipment responses can return notifyBeforeArrival in accessorials.

Freight items on Create a quote take an optional pieceCount, the number of pieces inside each handling unit, and pieceType. The bill of lading for an API-booked shipment prints them instead of "Pieces: N/A".

Freight items in quote and shipment responses return pieceCount and pieceType.

Retrieve a file answers 404 for an ID with no file and 400 for an ID that is not a Mothership file ID. Both used to return 500.

Track a shipment returns events without deliveryLocationName or pickupLocationName when the shipment has no recorded location name. Those responses used to come back as an empty results list.

Both fields are documented as optional.

Track a shipment events can carry an optional description, the carrier’s own words about the shipment’s progress.

Retrieve an invoice no longer lists paidAmount and creditedAmount, which the API never returned.

Remove a webhook configuration documents data as an empty object, matching the { "data": {} } the API returns, instead of a string.

Documented as optional: updatedAt on Retrieve your account; name and phoneNumber on shipment pickup and delivery, and description on shipment freight items; truck and serviceType on rates, field on invalidFieldsRequiredForPurchase items, and city on quote pickup and delivery.

Documented as always present: services, warnings, creditsApplied, coveragePrice and coveredValue on rates; invalidFieldsRequiredForPurchase, pickupLocationSuggestedAccessorials and deliveryLocationSuggestedAccessorials in quote metadata; accessorials and emails on quote and shipment locations.

The id, createdAt and updatedAt descriptions on Retrieve your account describe your company account instead of a payment term.

Freight items on Create a quote take an optional nmfcCode and freightClass. A freightClass you send replaces the density-based class the shipment would otherwise be rated at.

Freight items in quote and shipment responses return both, and freightClass shows the class the shipment was rated at.

Retrieve an invoice documents id, createdAt and amount on each credits and payments item. The API already returned them.