2026-01

2026-01 Release Notes

Fulfillments

We have introduced a new set of endpoints to support advanced fulfillment workflows, including picking, packing, and fulfilling orders.

New Endpoints

  • GET /fulfillments: Retrieve a paginated list of fulfillment summary items. Supports filtering by outlet_id, sale_id, fulfillment_type, and fulfillment_state.
  • POST /fulfillments/fulfill: Fulfill a sale. This is an idempotent action that completes all fulfillments for a given sale.
  • POST /fulfillments/{fulfillment_id}/fulfill: Fulfill specific line items within a sale.
  • POST /fulfillments/{fulfillment_id}/pack: increment pack quantity for line items within a sale.
  • POST /fulfillments/{fulfillment_id}/pick: increment pick quantity for line items within a sale.

Inventory

We have introduced new endpoints for querying inventory and inventory levels.

New Endpoints

  • GET /inventory/{product_id}: Retrieve inventory for a single product. This endpoint replaces api/2.0/products/{product_id}/inventory.
  • POST /inventory_levels: Retrieve a paginated list of inventory levels.
  • GET /inventory_levels/{product_id}: Retrieve a paginated list of inventory levels for a single product. Supports filtering by inactive status.

Deprecations

  • GET api/2.0/products/{product_id}/inventory: Deprecated. Please use /inventory/{product_id} instead.

Gift Cards

The Gift Cards API allows you to query, create, and manage gift cards and their transactions.

New Endpoints

  • GET /gift_cards/by_number/{card_number}: Find a gift card by its number.
  • GET /gift_cards/by_id/{id}: Find a gift card by its ID.