2.20190313.0

Version 2.20190313.0 (2019-03-13)

New API: Labor API

The Labor API now includes functionality
that gives a Square account the ability to track and retrieve employee labor hours
including multiple hourly wage rates per employee, work shift break tracking, and
standardized break templates.

See the Connect v2 Technical Reference.

New API: Employees API

The Employees API includes the ability to list employees for a Square
account and retrieve a single employee by ID.

See the Connect v2 Technical Reference.

Improvement: Simplified OAuth access token renewal

The RenewToken endpoint is now deprecated and replaced with new functionality in ObtainToken.
ObtainToken now returns a refresh token along with an access token. Refresh
tokens are used to renew expired OAuth access tokens.

2.20190213.0

Version 2.20190213.0 (2019-02-13)

New feature: Order fulfillment BETA

The Orders API now includes beta
functionality that supports in-person fulfillment through Square Point of Sale
for orders placed online.

Improvement: New CreateOrder request structure

The CreateOrderRequest datatype now groups order details under a single
object.

Improvement: CreateOrder requests preserve order-level price adjustment objects

The CreateOrderResponse datatype now retains structure of order-level
price adjustments in addition to converting them to scoped, line-item price
adjustments. Previously, CreateOrderResponse did not preserve the original
order-level price-adjustment objects.

2.20181212.0

Version 2.13.0 (2018-12-12)

Improvement: ListCustomers return set expanded

Requests to the ListCustomers endpoint now returns all available customer profiles. Previously, ListCustomers only returned customer profiles explicitly created through the Customers API or Square Point of Sale.

2.20181205.0

Version 2.20181205.0 (2018-12-05)

New feature: Idempotent customer profile creation in Connect v2

Requests to the CreateCustomer endpoint now include a idempotency_key field to
ensure idempotent creation of new profiles.

New feature: Refund Adjustment fields for Refunds in Connect v1

The Connect SDK now supports refund adjustments for the Connect v1
Refunds API with the addition of multiple new fields in the Refund data type

2.20180918.1

Version 2.20180918.1 (2018-10-24)

New feature: Support for Partial Payments in Connect v1

The Connect SDK now supports partial payment functionality for the Connect v1 Transactions API with the addition of a new Payment field:

• Payment.is_partial — Indicates whether or not the payment is only partially paid for. If true, the payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

Tender also includes 2 new fields to help resolve timing around payments with multiple tenders. Invoices that involve partial payment (e.g., requiring a deposit) may include tenders settled well before the entire payment is completed:

• Tender.tendered_at — The time when the tender was accepted by the merchant.
• Tender.settled_at — The time when the tender was captured, in ISO 8601 format. Typically the same as (or within moments of) tendered_at unless the tender was part of a delay capture transaction.

The change also makes some behavioral changes to the Connect v1 Payment endpoints:

• Create Refunds rejects requests for invoices that have partial payments pending.
• List Payments takes a new request field, include_partial to indicate whether partial payments should be included in the response.

2.20180918.0

Version 2.20180918.0 (2018-09-18)

We have added Connect v2 Inventory API and birthdays in Customer entities.

New API: Inventory API (Connect V2)

The Connect v2 Inventory API replaces the Connect v1 Inventory API
and introduces new functionality:

• Moving item variations quantities through predefined states
  (e.g., from IN_STOCK to WASTE).
• Viewing the inventory adjustment history for an item variation.
• Batch inventory adjustments and information retrieval.

New feature: Customer Birthdays (Connect V2)

• Customer profiles now include a birthday field.
  Dates are recorded in RFC-3339 format and can be
  set through the CreateCustomer and UpdateCustomer endpoints.

Remove singleton constraint for configuration class. This is a minor breaking change to ApiClient
and RESTClientObject initialization.

2.20180712.2

Version 2.20180712.2 (2018-08-21)

The Connect SDK now includes functionality for the OAuth API. The Square OAuth API lets applications request and obtain permission from a Square account to make API calls on behalf of that account. Applications can request individual permissions so that users do not need to grant full access to their Square accounts.

OAuth API

• ObtainToken endpoint — Exchanges the authorization code for an access token. After a merchant authorizes your application with the permissions form, an authorization code is sent to the application's redirect URL (See Implementing OAuth for information about how to set up the redirect URL).

• RenewToken endpoint — Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after 30 days. You can also renew expired tokens within 15 days of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated merchant must complete the OAuth flow from the beginning. Important: The Authorization header you provide to this endpoint must have the following format: Authorization: Client APPLICATION_SECRET Replace APPLICATION_SECRET with your application's secret, available from the application dashboard.

• RevokeToken endpoint — Revokes an access token generated with the OAuth flow. If a merchant has more than one access token for your application, this endpoint revokes all of them, regardless of which token you specify. If you revoke a merchant's access token, all of the merchant's active subscriptions associated with your application are canceled immediately. Important: The Authorization header you provide to this endpoint must have the following format: Authorization: Client APPLICATION_SECRET Replace APPLICATION_SECRET with your application's secret, available from the application dashboard.

2.20180712.1

Version 2.20180712.1 (2018-08-02)

We have added MobileAuthorization API.

New endpoint: MobileAuthorization API

• CreateMobileAuthorizationCode endpoint — Generate a mobile authorization code for an instance of your application. Mobile authorization credentials permit an instance of your application to accept payments for a given location using the Square Reader SDK. Mobile authorization codes are one-time-use and expire shortly after being issued.

2.20180712.0

Version 2.20180712.0 (2018-07-12)

We introduce Square API versions. Square-Version is 2018-07-12 for this SDK.

How versioning works

Square API versions (Square-Version) track changes in the evolution of Connect
v2 APIs. The Square-Version naming scheme is YYYY-MM-DD, which indicates
the date the version was released. Connect v1 APIs are not versioned. Square
continues to support Connect v1, but future releases will focus on improving
Connect v2 functionality.

By default, new Square applications are pinned to the version current at the
time the application was created in the Square Application Dashboard. Pinning an
application sets the default Square-Version for the application. The default
Square-Version of an application can be reviewed and updated at any time on
the settings pages for the application.

Versioning and SDKs

When a new Square-Version is released, new Connect SDKs are publish on GitHub
and various package management systems. SDK updates follow the version
convention of the associated language and manager but include the related
Square-Version in the SDK version. For example, Connect SDKs tied to version
2018-01-04 might look like {SDK_VERSION}.20180104.{VERSION_INCREMENT}.

While SDK versions can be mapped to a related Square-version, SDK versions
follow an independent, incremental versioning scheme to allow updates and
improvements to the SDKs outside of Square-Version updates.

Migrating to new versions

In most cases, Square-version migration should be straightforward, with known
differences listed in the related Change Log.

To test migrations, developers can override the default Square-Version of an
application by explicitly setting the preferred Square-Version in the HTTP
header of the Connect v2 API request for REST calls. Requesting an API version
that does not exist returns an error. Successful API responses include the
Square-Version header to indicate the API version used to process request.

Connect SDK versions are locked to specific API versions and cannot be
overwritten. Instead, the SDK must be upgraded to work with new API versions.

2.9.0

Version 2.9.0 (2018-06-28)

We have added search functionality to the Connect v2 Customer API.

New features and Improvements: Customer API (Connect v2)

• SearchCustomers endpoint — retrieves groups of customer profiles
  based on a related characteristic. For example, retrieving all customers
  created in the past 24 hours.
• creation_source field is now available on Customer entities. The creation
  source exposes the process that created a customer profile. For example, if
  a customer is created using the API, the creation source will be
  THIRD_PARTY.
• Instant Profiles are now exposed in the following endpoints:
  RetrieveCustomer, SearchCustomers, UpdateCustomer, DeleteCustomer.

Fixes: Inventory SDK (Connect v1)

• Fix SDK request property adjustment_type in V1 Adjust Inventory.