Changelog

2026-09-25: gift certificate reload and adjust; store credit

• Gift certificates: POST /v1/gift-certificates/{id}/reload adds value; POST /v1/gift-certificates/{id}/adjust corrects the balance either way with a reason. Both require an Idempotency-Key.
• Store credit: a new store_credit permission. Read a customer's balance and ledger, read the ledger across customers, and issue (refund or adjustment) or redeem credit. Issue and redeem require an Idempotency-Key. New webhook store_credit.changed.

2026-09-25: write access for gift certificates, coupons and locations

• Gift certificates: issue, redeem and reverse (an Idempotency-Key is required), disable and enable. New webhooks gift_certificate.issued and gift_certificate.updated.
• Coupons: create, update and delete; store+online coupons sync to BigCommerce.
• Locations: PATCH phone, email and business hours.

2026-09-25: v1

The first release of the Black Beach POS API.

• API keys. Owner-issued, with per-resource none/read/write permissions, location limits, IP allowlists, expiry, and rolling with a grace period.
• Resources.
  • Products (with categories and vendors).
  • Inventory levels, lots (lot number, expiry, quantity), serialized units and the movement ledger.
  • Customers, with date of birth behind its own permission.
  • Orders, including creating orders from outside channels (with lot selection) and voiding them.
  • Purchase orders: create, edit, submit, cancel, and receive (lot-tracked lines with their lot number).
  • Returns, gift certificates, coupons and locations.
  • /v1/me and the /v1/events feed.
• Webhooks. 21 event types, HMAC-SHA256 signatures with secret rotation, a custom auth header, retries over about 37 hours, auto-disable, and resend from the delivery log.
• Limits. Established: 60 requests per minute and 10,000 per day. Enterprise: 600 per minute.
• Sandbox. sandbox.blackbeachpos.com, with a shop per partner and daily simulated activity.