Skip to main content

API Changelog

This page tracks every change to the Spoke Connect API and the day it happened. When a new version is released, this is the easiest place to find what changed, whether a breaking change or a new feature.

note

The dates here are formatted as YYYY-MM-DD.

[v1] - Unreleased​

Added​

  • POST /orders:withdraw reports orders paid on platform in failed[] with the order_paid code. These orders stay submitted to their courier. See Submit and withdraw an order.

[v1] - 2026-09-16​

Added​

  • Orders accept packageInfo.weight with an explicit amount and unit (kilogram, pound, or metric-ton). Responses include the weight in the retailer's configured unit. See Weight and units.

Deprecated​

  • packageInfo.packageLoadAmount is deprecated. It continues to accept and return grams; earlier documentation incorrectly described it as using the retailer's configured unit. Existing integrations keep their current behavior. See Migrating from packageLoadAmount.

Changed​

  • Create, import, and update requests validate recipient.email as a single valid email address. Invalid addresses and lists of addresses are rejected.
  • Updating an order with deliveryInstructions.handOffInfo.pickupLocationId: null preserves its existing location. An order's location can be changed, but cannot be cleared.

Fixed​

  • Creating or importing an order preserves the explicitly requested deliveryInstructions.handOffInfo.handOffType.

[v1] - 2026-07-31​

Changed​

  • Shipping-label PDFs include the retailer's ship-from address and phone number.

[v1] - 2026-07-30​

Fixed​

  • Withdrawing an order that is already scheduled or was created by a courier returns the specific order_already_scheduled or order_courier_managed error, even when the order is also read-only.

[v1] - 2026-07-27​

Added​

  • Submitting pickup-by-courier orders creates linked pickup stops. Withdrawing the last linked delivery removes its automatically generated pickup.

Changed​

  • Pickup-by-courier submissions are rejected when their pickup location cannot be resolved.

[v1] - 2026-07-22​

Initial release of the Spoke Connect API.

  • Orders: create, batch import (POST /orders:import), edit, delete, list, and retrieve orders, submit them to a courier and withdraw them before they ship, and download printable PDF labels.
  • Couriers and pickup locations: read-only endpoints to look up the couriers that deliver your orders and the pickup locations they ship from.
  • API-key authentication with the Bearer and Basic schemes. See Authentication.