Changelog
Keep track of every change that occurs to the Pandabase API.
This changelog lists all additions and updates to the Pandabase API, in
chronological order. Release dates can be converted to Pandabase-Version
by using the following order YYYY/MM/DD
.
October 22, 2024
-
New Properties:
tax_calculation_enabled
localized_pricing_enabled
regional_pricing_enabled
checkout_collect_phone_enabled
checkout_verify_email_enabled
plan
-
Endpoints Affected:
/shops
/shops/flags
/products
/categories
/coupons
-
Renamed Property:
cash_app
has been renamed tocashapp
in thePaymentMethod[]
flag object.
-
Added Payment Methods:
venmo
paypal
multiple_cards
(supporting Visa, MasterCard, etc.)
-
Removed Property:
stripe_connect
has been removed from theFlag
object.
-
Products:
- Added
images[{ id, hash, path, preview_url, resolution }]
toProduct[]
and theProduct
object. - Added
categories[]
toProduct[]
and theProduct
object.
- Added
-
Shops:
- Added
icon_url
toShop[]
and theShop
object.
- Added
-
Pagination List request responses now include a
meta
object with pagination information. The default values are:page_size
:10
page
:1
-
Filtering and Sorting Optional capabilities for advanced sorting, filtering and searching has been added to list endpoints.
filter
(Applies filters to the query using defined operators)- Operators:
eq
,ne
,gt
,gte
,lt
,lte
,in
,nin
,contains
.
- Operators:
sort
(Defines the sorting criteria for the results)search
(A search term that looks for matches)
October 5, 2024
- Fixed bugs with File API.
- Advanced sorting and filtering capabilities for the following endpoints:
/products
/categories
/coupons
- Beta support for subscriptions.
- Beta support for new serial keys.
- Performance enhancements across the API.
September 20, 2024
-
MoR Model: Introduced an optional MoR model for users who wish to opt in.
-
Advanced Analytics: Added support for advanced analytics.
-
Dynamic Payments: Implemented support for dynamic payments.
-
Idempotency Support: Added idempotency support for
POST
,PUT
, andPATCH
requests. -
Payments Endpoint: Launched a new
/payments
endpoint to support finite-based payments. -
Intent-Based Flags: Introduced new intent-based flags.
-
File API: Added a new intent-based file API at
/files
. -
Updated responses and requests for the following endpoints:
/shops
/products
/categories
/coupons
/orders
/refunds
/disputes
/carts
/webhooks
August 30, 2024
- Added new
/public
endpoints with multiple options for filtering. - Added new
/onboarding
and/login
endpoints. - Deprecated support for
transactions[]
and replaced withpayment[]
. - Added
flags
toshops
.
July 29, 2024
- Added
/{shopId}/carts
to initiate a new cart. - Added
cartId?
optional param to order intent creation object.
June 6, 2024
- Added:
/categories
route with support for listing categories, creating, getting, deleting, and updating.categories
field to the product model.
- Changed:
- Renamed response payloads for the following endpoints:
- POST
/products
: Now returns{ product: { ... } }
instead of directly returning the product object. - GET
/products
: Now returns{ products: [{ ... }] }
instead of directly returning the product list. - GET
/products/{id}
: Now returns{ product: { ... } }
instead of directly returning the product object.
- POST
- Renamed response payloads for the following endpoints:
May 13, 2024
- Changed:
- Renamed
shop
route toshops
.
- Renamed
- Added:
payout
route with support forpage
andpageSize
parameters.recipients
route for adding payout information.flags.requirements.payouts
andflags.requirements.kyc{status, checked_at}
to the/user
object.customer
route with support for auth tokens of types["login", "register", "token"]
(action-based auth).- Sending of payout emails.
documents
route for KYC-related tasks.
- Removed:
paid_at
attribute from the payout object.
- Updated:
recipient.compliance.status
added to/user
.- Successful API operations now return
OK
status instead ofSUCCESS
. - Supported Stripe Express accounts.
- New health check message on
/healthcheck
route. image_hash
returned on public endpoints.coupon.enabled
added to coupons.payments
route for payment flow creation.
April 3, 2024
- Updated:
- Event terminology from
transaction
toorder
object. - The event type previously referred to as
transaction
has been standardized asorder
object. The associated identifier now returns asorder.id
. - Renamed all
transaction
event types toorder
for consistency.
- Event terminology from
- Added:
- New event types related to payments:
payment
event type.- New status events under
payment
:payment.pending
: Indicates a pending payment.payment.paid
: Denotes a successfully processed payment.payment.success
: Signifies a successfully completed payment transaction.payment.failed
: Indicates a failed payment transaction.
- New event types related to payments:
March 12, 2024
- Added the following properties:
- To the
account
object:account["flags"]["verified"]
account["flags"]["two_fa_enabled"]
account["flags"]["deleted"]
account["flags"]["requirements"]{"activated"}
- To the
shop
object:shop["analytics"]["total_sales"]
shop["analytics"]["total_earned"]
shop["analytics"]["pending_balance"]
shop["analytics"]["dispute_rate"]
shop["flags"]["statement_descriptor"]
shop["flags"]["features"]["pmp_enabled"]
shop["flags"]["features"]["chargeback_protection_enabled"]
shop["flags"]["features"]["storefront_enabled"]
shop["flags"]["features"]["checkout_api_enabled"]
shop["flags"]["features"]["domain_enabled"]
shop["flags"]["features"]["ssl_enabled"]
shop["flags"]["connect"]{"id", "enabled", "type"}
- To the
transaction
object:transactions["fee"]
transactions["early_fraud_warning"]
- To the
order
object:order["discounted"]
order["discount_code"]
order["customer"]["customer_id"]
order["customer"]["shipping_address_id"]
order["customer"]["billing_address_id"]
- To the
order_item
:product["name"]
asorder_item["name"]
product["id"]
asorder_item["product_id"]
order_itemp["quantity"]
- To the
refund
object:refund["reason"]
refund["status"]
- To the
dispute
object:dispute["dispute_id"]
dispute["reason"]
dispute["status"]
dispute["method"]
dispute["amount"]
dispute["total_amount"]
dispute["fee"]
- To the
coupon
object:coupon["name"]
coupon["code"]
coupon["type"]
coupon["value"]
coupon["limit"]
coupon["limit_enabled"]
address["state"]
to theshipping_address
andbilling_address
objects.analytics["dispute"]
to theanalytics
object.
- To the
February 20, 2024
- General Team release
February 15, 2024
- Implemented support for
sortBy.status
, andsortBy.date
query parameters in the List Orders route.