- Change
timecard_idas path parameter forListTimecardEventsendpoint - Change
ended_atto string type forV1CashDrawerShifttype
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.
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.
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.
The Orders API now includes beta functionality that supports in-person fulfillment through Square Point of Sale for orders placed online.
The CreateOrderRequest datatype now groups order details under a single
object.
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.
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.
Requests to the CreateCustomer endpoint now include a idempotency_key field to
ensure idempotent creation of new profiles.
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
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. Iftrue, 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_atunless 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_partialto indicate whether partial payments should be included in the response.
We have added Connect v2 Inventory API and birthdays in Customer entities.
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_STOCKtoWASTE). - Viewing the inventory adjustment history for an item variation.
- Batch inventory adjustments and information retrieval.
- Customer profiles now include a
birthdayfield. Dates are recorded in RFC-3339 format and can be set through theCreateCustomerandUpdateCustomerendpoints.
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.
Updated the SDK target to be .net standard 2.0.
-
ObtainTokenendpoint — 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). -
RenewTokenendpoint — 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: TheAuthorizationheader you provide to this endpoint must have the following format:Authorization: Client APPLICATION_SECRETReplaceAPPLICATION_SECRETwith your application's secret, available from the application dashboard. -
RevokeTokenendpoint — 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: TheAuthorizationheader you provide to this endpoint must have the following format:Authorization: Client APPLICATION_SECRETReplaceAPPLICATION_SECRETwith your application's secret, available from the application dashboard.
We have added MobileAuthorization API.
CreateMobileAuthorizationCodeendpoint — 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.
We introduce Square API versions. Square-Version is 2018-07-12 for this SDK.
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.
When a new Square-Version is released, new Connect SDKs are publish on GitHub
and various package management systems.
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.
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.
Dependencies updated for compatibility with .NET Core 2.0
We have added search functionality to the Connect v2 Customer API.
SearchCustomersendpoint — retrieves groups of customer profiles based on a related characteristic. For example, retrieving all customers created in the past 24 hours.creation_sourcefield is now available onCustomerentities. 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 beTHIRD_PARTY.- Instant Profiles are now exposed in the following endpoints:
RetrieveCustomer,SearchCustomers,UpdateCustomer,DeleteCustomer.
- Fix SDK request property
adjustment_typein V1 Adjust Inventory.
We have added sorting functionality to the Connect v2 Customer API, updated the Connect v1 Payments API to include information about surcharges and improvements to the Item data type.
- ListCustomers endpoint — now provides the ability to sort
customers by their creation date using the
sort_fieldandsort_orderparameters.
The Payments API now returns information about surcharges applied to payments. The new functionality introduces the following new data types:
- SurchargeMoney datatype — The total of all surcharges applied to the payment.
- Surcharges datatype — A list of all surcharges associated with the payment.
- Surcharge datatype — A surcharge that is applied to the payment. One example of a surcharge is auto-gratuity, which is a fixed-rate surcharge applied to every payment, often based on party size.
We are constantly evaluating new languages to add. In the meantime, if the language you need is not supported, you can use our [Swagger pipeline](<%= articles__client_libraries_path%>#generatingwithswagger) to generate a custom SDK or continue sending JSON to the endpoint URLs directly.
Item will now provide two new properties:
category_id— indicates if an item can be added to pickup orders from the merchant's online storeavailable_for_pickup— indicates the item's category (if any).
The Transactions API in Connect v2 now includes payment and refund information from exchanges.
ListTransactionsnow includes payment information from sales and exchanges and refund information from returns and exchanges.ListRefundsnow includes refunds that result from exchanges in addition to partial refunds and itemized returns through Square's Point of Sale applications.
The Payments API in Connect v1 now includes payment and refund information from exchanges.
ListPaymentsnow includes refunds that are generated from exchanges to account for the value of returned goods.ListRefundsnow returns an approximate number of refunds (default: 100, max: 200). The response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated from exchanges to account for the value of returned goods.is_exchangeis added toV1RefundandV1Tender. Refunds and tenders marked in this way represent the value of returned goods in an exchange, rather than actual money movement.
BatchRetrieveOrderswill now return uncharged orders.
- For Catalog-backed line items, setting
CreateOrderRequestLineItem.base_price_moneywill now override the catalog item variation's price. CreateOrderRequestModifiers may now be created ad hoc using the newnameandbase_price_moneyfields.
OTHERenum value is added toTypeonV1SettlementEntry
ordinalis added toCatalogItemVariationwebsite_urlis added toLocationtip_moneyis added toTender- Changed
object_typeandplaceholder_typefrom lists to single values inV1PageCellto mirror data model
The Transaction API now supports the following request objects:
additional_recipients— data type representing an additional recipient (in other words, a recipient other than the merchant or Square) receiving a portion of a tender.
The new Reporting API includes two endpoints that let you pull information about distributions you have received as an additional recipient:
-
AdditionalRecipientReceivables— returns a list of receivables (across all source locations) representing monies credited to the given location ID by another Square account using theadditional_recipientsfield in a transaction. -
AdditionalRecipientReceivablesRefunds— returns a list of refunded transactions (across all source locations) related to monies credited to the given location ID by another Square account using theadditional_recipientsfield in a transaction.
RegisterDomainendpoint activates a domain for use with Web Apple Pay.
Location.typeused to indicate whether or not the location object represents a physical space.
Chargeendpoint can charge a specific Order.
CreateOrderendpoint creates an itemized order which can be referenced in messages to theChargeendpoint.BatchRetrieveOrdersretrieves order objects referenced in one or more transactions based on the providedorder_id.
Note: at this point, BatchRetrieveOrders only returns information on paid orders made through Square's eCommerce APIs (Transactions, Checkout).
orderis removed from Transactionorder_idis added to TransactionOrderLineItemDiscountType.UNKOWNrenamed toOrderLineItemDiscountType.UNKOWN_DISCOUNTOrderLineItemTaxType.UNKOWNrenamed toOrderLineItemDiscountType.UNKOWN_TAXChargeRequest.idempotency_keyis restricted to max length 192ChargeRequest.card_nonceis restricted to max length 192ChargeRequest.customer_card_idis restricted to max length 192ChargeRequest.reference_idis restricted to max length 40ChargeRequest.noteis restricted to max length 60ChargeRequest.customer_idis restricted to max length 50CreateCheckoutRequest.redirect_urlis restricted to max length 800- Added
phone_numberandbusiness_nameto Location
- Documentation style and links fixes
- Support for pagination on V1 endpoints
- Include refund detail fields on V1 Refund model