API Change Log - 4 Nov - 2025 - DRAFT

Webstore V2

  • API Endpoint: {api_url}/v1/invoices/giftcards

  • Scenario: This API generates an invoice by booking the gift cards and returns a unique invoice ID as the response.

  • API method: POST

  • Earlier behavior: The API created a gift card sale invoice without identifying online guests separately.

  • New behavior: The API now includes a new online_guest_id field to support "Checkout as guest" for online gift card purchases.

Webstore V1, Webstore V2

  • API Endpoint: {api_url}/v1/centers/{center_id}/packages

  • Scenario: This API retrieves the list of regular packages which are available for sale at a center.

  • API method: GET

  • Earlier behavior: Endpoint listed center packages, without member pricing, guest context, or gift-card-enabled filtering or discounted price.

  • New behavior: Endpoint adds member_price, guest_id, and is_giftcard_enabled; returns centers.discount_price for members when guest_id is provided and API key is used.

Webstore V1, Webstore V2

  • API Endpoint: {api_url}/v1/giftcards/templates?center_id={center_id}&giftcardtype={giftcardtype}&serviceOnly={serviceOnly}&fromOnline={fromOnline}&member_price={member_price}&guest_id={guest_id}

  • Scenario: This API retrieves gift card amount templates based on the specified criteria including gift card type, center preferences, and member pricing options.

  • API method: GET

  • Earlier behavior: The API returned gift card templates using center and type parameters, without member-specific pricing or guest validation.

  • New behavior: The API adds guest_id with member_price to support API-key calls, returns discounted_price, and enforces token–guest consistency.

Webstore V2

  • API Endpoint: v1/guests/online_guests

  • Scenario: This API creates new v1 online guests.

  • API method: POST

  • Earlier behavior: New API. No earlier behavior.

  • New behavior: POST v1/guests/online_guests creates online guests and returns online_guest_id and guest_id identifiers, with API key or guest token authorization

Reports – Core V2

  • API Endpoint: {api_url} /v1/reports/sales/cash_basis/flat_file

  • Scenario: This API retrieves the Sales cash report data.

  • API method: POST

  • Earlier behavior: The API Returned Sales Cash data without refund_reason.

  • New behavior: The API adds refund_reason to SalesCashItem.