square-connect
Advanced tools
Changelog
Version 6.20201216.0 (2020-12-16T00:00)
Orders API:
OrderLineItemPricingBlocklists. You can explicitly specify taxes and discounts in an order or automatically apply preconfigured taxes and discounts to an order. In addition, you can now block applying these taxes and discounts to a specific OrderLineItem in an order. You add the pricing_blocklists
attribute to individual line items and specify the blocked_discounts
and blocked_taxes
that you do not want to apply. For more information, see Apply Taxes and Discounts. For example walkthroughs, see Automatically Apply Discounts and Automatically Apply Taxes.
OrderPricingOptions. Previously, the pricing_options
field in an order supported only auto_apply_discounts
to enable the automatic application of preconfigured discounts. Now it also supports auto_apply_taxes
to enable the automatic application of preconfigured taxes. For more information, see Automatically apply preconfigured catalog taxes or discounts.
OrderLineItemTax. It now includes the new auto_applied
field. It indicates whether the tax was automatically applied using a preconfigured CatalogTax.
Bookings API:
Catalog API:
catalog_version
filter to return catalog objects of the specified version.Customers API:
email_address
, group_ids
, phone_number
, and reference_id
query filters are now generally available (GA).Invoices API: (beta)
custom_fields
field, which contains up to two customer-facing, seller-defined fields to display on the invoice. For more information, see Custom fields.Loyalty API: (beta)
definition
field in this type is deprecated and replaced by the new pricing_rule_reference
field. You can use pricing_rule_reference
fields to retrieve catalog objects that define the discount details for the reward tier. For more information, see Get discount details for a reward tier.Square Node.js SDK:
The new Square Node.js SDK is now GA and replaces the deprecated Connect Node.js SDK. For migration information, see the Connect SDK README.
Changelog
Version 5.20201118.0 (2020-11-18T00:00)
risk_evaluation
field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment.New Square Node.js SDK (beta)
The new Square Node.js SDK is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the Connect SDK README. The following topics are updated to use the new SDK:
Changelog
Version 4.20201028.5 (2020-10-28T00:00)
Terminal API. New endpoints to enable sellers in Canada refund Interac payments.
New endpoints:
New webhooks:
terminal.refund.created
. Notification of a new Terminal refund request.terminal.refund.updated
. Notification that a Terminal refund request state is changed.New topic Refund Interac Payments.. Describes how to refund Interac payments.
Loyalty API (beta):
Locations API:
Orders API:
Invoices API (beta):
INSTALLMENT
request types. This is a service-level change that applies to all Square API versions. For more information, see Payment requests.Changelog
Version 4.20200923.4 (2020-09-23T00:00)
PAYMENT_PENDING
value. Previously, the Invoices API returned a PAID
or PARTIALLY_PAID
status for invoices in a payment pending state. Now, the Invoices API returns a PAYMENT_PENDING
status for all invoices in a payment pending state, including those previously returned as PAID
or PARTIALLY_PAID
.limit
parameter.limit
parameter.device_installation_id
field.Payment.status
changes and how the status relates to the seller receiving the funds.PaymentRefund.status
changes and how the status relates to the cardholder receiving the funds.REFUND_DECLINED
error code.Changelog
Version 4.20200826.3 (2020-08-26T00:00)
total_tip_money
field is now GA.CreateOrder
endpoint POST /v2/orders
). The location-scoped variants of these endpoints (for example, the CreateOrder
endpoint POST /v2/locations/{location_id}/orders
) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body).Shift.employee_id
field to the Shift.team_member_id
field of the Labor API.Changelog
Version 4.20200812.2 (2020-08-12T00:00)
SUBSCRIPTION_PLAN
type. For more information, see Set Up and Manage a Subscription Plan.Changelog
Version 4.20200722.1 (2020-07-22T00:00)
Catalog API
Locations API
Merchants API
main_location_id
.Orders API
auto_apply_discounts
of the options to have rule-based discounts automatically applied to an Order that is pre-configured with a pricing rule.Terminal API (beta)
TerminalCheckoutCancelReason
field is renamed to ActionCancelReason
.Catalog API
Orders API
Changelog
Version 4.20200625.0 (2020-06-25T00:00)
Catalog API
Payments API
Changelog
Version 3.20200528.0 (2020-05-28)
Orders API
Order.rewards
represents rewards added to an order by calling the CreateLoyaltyReward endpoint.Order.discount.reward_ids
indicates that a discount is the result of the specified rewards that were added to an order using the CreateLoyaltyReward
endpoint.Customers API
email_address
query filter (beta) supports an exact or fuzzy search for customer profiles by their email addresses.phone_number
query filter (beta) supports an exact or fuzzy search for customer profiles by their phone numbers.reference_id
query filter (beta) supports an exact or fuzzy search for customer profiles by their reference IDs.created_at
, updated_at
, and id
attributes on the Customer resource are updated to be optional. As a result, they no longer are required input parameters when you call the Square SDKs to create a Customer
object. You might need to update the dependent SDKs to the latest version to mediate breaking your existing code.Changelog
Version 3.20200422.2 (2020-04-25)
scopes
property from the request body.