Partager via


Square Business (Independent Publisher) (Preview)

Square helps millions of sellers run their business - from secure credit card processing to point of sale solutions. This connector contains actions for the following endpoints: Loyalty, Gift Cards, Bookings, Business, Team, Financials, Online and Auth.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://squareup.com/
Privacy policy https://squareup.com/us/en/legal/general/privacy
Categories Commerce;Sales and CRM

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Accumulate loyalty points

Adds points to a loyalty account.

Adjust loyalty points

Adds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points.

Bulk create team members

Creates multiple TeamMember objects.

Bulk update team members

Updates multiple TeamMember objects.

Calculate loyalty points

Calculates the points a purchase earns. An application might call this endpoint to show the points that a buyer can earn with the specific purchase.

Create booking (Beta)

Creates a booking.

Create break type

Creates a new BreakType. A BreakType is a template for creating Break objects.

Create checkout

Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow.

Create device code

Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Create gift card activity (Beta)

Creates a gift card activity.

Create location (Beta)

Creates a location.

Create loyalty account

Creates a loyalty account.

Create loyalty reward

Creates a loyalty reward. After a reward is created, the points are locked and not available for the buyer to redeem another reward.

Create mobile authorization code

Generates code to authorize a mobile application to connect to a Square card reader. Authorization codes are one-time-use and expire 60 minutes after being issued.

Create shift

Creates a new Shift. A Shift represents a complete workday for a single employee

Create team member

Creates a single TeamMember object.

Delete break type

Deletes an existing BreakType. A BreakType can be deleted even if it is referenced from a Shift.

Delete loyalty reward

Deletes a loyalty reward. Returns the loyalty points back to the loyalty account. You cannot delete a reward that has reached the terminal state (REDEEMED).

Delete shift

Deletes a shift

Delete snippet

Removes your snippet from a Square Online site.

Get bank account

Returns details of a BankAccount linked to a Square account.

Get bank account by V1 ID

Returns details of a BankAccount identified by V1 bank account ID.

Get break type

Returns a single BreakType specified by id.

Get device code

Retrieves DeviceCode with the associated ID.

Get shift

Returns a single Shift specified by id.

Get team member wage

Returns a single TeamMemberWage specified by id.

Link customer to gift card (Beta)

Links a customer to a gift card

List bank accounts

Returns a list of BankAccount objects linked to a Square account.

List break types

Returns a paginated list of BreakType instances for a business.

List cash drawer shift events

Provides a paginated list of events for a single cash drawer shift.

List cash drawer shifts

Provides the details for all of the cash drawer shifts for a location in a date range.

List device codes

Lists all DeviceCodes associated with the merchant.

List gift card activities (Beta)

Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

List locations

Provides information of all locations of a business.

List merchants

Returns Merchant information for a given access token.

List sites

Lists the Square Online sites that belong to a seller.

List team member booking profiles (Beta)

Lists booking profiles for team members.

List team member wages

Returns a paginated list of TeamMemberWage instances for a business.

List workweek configs

Returns a list of WorkweekConfig instances for a business.

Redeem loyalty reward

Redeems a loyalty reward. After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.

Retrieve business booking profile (Beta)

Retrieves a seller's booking profile.

Retrieve cash drawer shift

Provides the summary details for a single cash drawer shift.

Retrieve gift card (Beta)

Retrieves a gift card using its ID.

Retrieve gift card from GAN (Beta)

Retrieves a gift card using the gift card account number (GAN).

Retrieve gift card from nonce (Beta)

Retrieves a gift card using a nonce (a secure token) that represents the gift card.

Retrieve location

Retrieves details of a location. You can specify "main" as the location ID to retrieve details of the main location.

Retrieve loyalty account

Retrieves a loyalty account.

Retrieve loyalty program

Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword main. Loyalty programs define how buyers can earn points and redeem points for rewards.

Retrieve loyalty reward

Retrieves a loyalty reward.

Retrieve merchant

Retrieve a Merchant object for the given merchant_id.

Retrieve snippet

Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.

Retrieve team member

Retrieves a TeamMember object for the given TeamMember id.

Retrieve wage setting

Retrieves a WageSetting object for a team member specified by TeamMember id.

Search availability (Beta)

Searches for availabilities for booking.

Search loyalty accounts

Searches for loyalty accounts in a loyalty program.

Search loyalty events

Searches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in the point balance (for example, points earned, points redeemed, and points expired) is recorded in the ledger. Using this endpoint, you can search the ledger for events.

Search loyalty rewards

Searches for loyalty rewards in a loyalty account.

Search shifts

Returns a paginated list of Shift records for a business.

Search team members

Returns a paginated list of TeamMember objects for a business.

Unlink customer from gift card (Beta)

Unlinks a customer from a gift card.

Update break type

Updates an existing BreakType.

Update location (Beta)

Updates a location.

Update shift

Updates an existing Shift.

Update team member

Updates a single TeamMember object.

Update wage setting

Creates or updates a WageSetting object.

Update workweek config

Updates a WorkweekConfig.

Upsert snippet

Adds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the head element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site.

Accumulate loyalty points

Adds points to a loyalty account.

Parameters

Name Key Required Type Description
Account ID
account_id True string

The identifier of the account.

Order ID
order_id string

The ID of the order.

Location ID
location_id string

The location identifier.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Returns

Name Path Type Description
ID
event.id string

The unique, Square-issued identifier.

Type
event.type string

The type of this object.

Created At
event.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Loyalty Program ID
event.accumulate_points.loyalty_program_id string

The ID of the loyalty program

Points
event.accumulate_points.points integer

The number of points accumulated by the event.

Order ID
event.accumulate_points.order_id string

The ID of the order associated with the activity.

Loyalty Account ID
event.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Location ID
event.location_id string

The identifier of the location.

Source
event.source string

The source.

Adjust loyalty points

Adds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points.

Parameters

Name Key Required Type Description
Account ID
account_id True string

The identifier of the account.

Points
points integer

The number of points added or removed.

Reason
reason string

The reason for this object.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Returns

Name Path Type Description
ID
event.id string

The unique, Square-issued identifier.

Type
event.type string

The type of this object.

Created At
event.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Loyalty Program ID
event.adjust_points.loyalty_program_id string

The ID of the loyalty program

Points
event.adjust_points.points integer

The number of points accumulated by the event.

Reason
event.adjust_points.reason string

The reason for the adjustment of points.

Loyalty Account ID
event.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Source
event.source string

The source.

Bulk create team members

Creates multiple TeamMember objects.

Parameters

Name Key Required Type Description
Given Name
given_name string

The given name (that is, the first name) associated with the team member.

Family Name
family_name string

The family name (that is, the last name) associated with the team member.

Email Address
email_address string

The email address associated with the team member.

Reference ID
reference_id string

A second ID used to associate the team member with an entity in another system.

Phone Number
phone_number string

The team member's phone number, in E.164 format.

Location IDs
location_ids array of string
Assignment Type
assignment_type string

The current assignment type of the team member.

Given Name
given_name string

The given name (that is, the first name) associated with the team member.

Family Name
family_name string

The family name (that is, the last name) associated with the team member.

Email Address
email_address string

The email address associated with the team member.

Reference ID
reference_id string

A second ID used to associate the team member with an entity in another system.

Phone Number
phone_number string

The team member's phone number, in E.164 format.

Assignment Type
assignment_type string

The current assignment type of the team member.

Returns

Name Path Type Description
ID
team_members.idempotency-key-1.team_member.id string

An identifier to reference this object.

Reference ID
team_members.idempotency-key-1.team_member.reference_id string

A second ID used to associate the team member with an entity in another system.

Is Owner
team_members.idempotency-key-1.team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_members.idempotency-key-1.team_member.status string

Describes the status of the team member.

Given Name
team_members.idempotency-key-1.team_member.given_name string

The given name (that is, the first name) associated with the team member.

Family Name
team_members.idempotency-key-1.team_member.family_name string

The family name (that is, the last name) associated with the team member.

Email Address
team_members.idempotency-key-1.team_member.email_address string

The email address associated with the team member.

Phone Number
team_members.idempotency-key-1.team_member.phone_number string

The team member's phone number, in E.164 format.

Assignment Type
team_members.idempotency-key-1.team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Location IDs
team_members.idempotency-key-1.team_member.assigned_locations.location_ids array of string
ID
team_members.idempotency-key-2.team_member.id string

An identifier to reference this object.

Reference ID
team_members.idempotency-key-2.team_member.reference_id string

A second ID used to associate the team member with an entity in another system.

Is Owner
team_members.idempotency-key-2.team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_members.idempotency-key-2.team_member.status string

Describes the status of the team member.

Given Name
team_members.idempotency-key-2.team_member.given_name string

The given name (that is, the first name) associated with the team member.

Family Name
team_members.idempotency-key-2.team_member.family_name string

The family name (that is, the last name) associated with the team member.

Email Address
team_members.idempotency-key-2.team_member.email_address string

The email address associated with the team member.

Phone Number
team_members.idempotency-key-2.team_member.phone_number string

The team member's phone number, in E.164 format.

Assignment Type
team_members.idempotency-key-2.team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Bulk update team members

Updates multiple TeamMember objects.

Parameters

Name Key Required Type Description
Reference ID
reference_id string

A second ID used to associate the team member with an entity in another system.

Is Owner
is_owner boolean

Whether the team member is the owner of the Square account.

Status
status string

Describes the status of the team member.

Given Name
given_name string

The given name (that is, the first name) associated with the team member.

Family Name
family_name string

The family name (that is, the last name) associated with the team member.

Email Address
email_address string

The email address associated with the team member.

Phone Number
phone_number string

The team member's phone number, in E.164 format.

Location IDs
location_ids array of string
Assignment Type
assignment_type string

The current assignment type of the team member.

Reference ID
reference_id string

A second ID used to associate the team member with an entity in another system.

Is Owner
is_owner boolean

Whether the team member is the owner of the Square account.

Status
status string

Describes the status of the team member.

Given Name
given_name string

The given name (that is, the first name) associated with the team member.

Family Name
family_name string

The family name (that is, the last name) associated with the team member.

Email Address
email_address string

The email address associated with the team member.

Phone Number
phone_number string

The team member's phone number, in E.164 format.

Assignment Type
assignment_type string

The current assignment type of the team member.

Returns

Name Path Type Description
ID
team_members.team_member_id.team_member.id string

An identifier to reference this object.

Reference ID
team_members.team_member_id.team_member.reference_id string

A second ID used to associate the team member with an entity in another system.

Is Owner
team_members.team_member_id.team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_members.team_member_id.team_member.status string

Describes the status of the team member.

Given Name
team_members.team_member_id.team_member.given_name string

The given name (that is, the first name) associated with the team member.

Family Name
team_members.team_member_id.team_member.family_name string

The family name (that is, the last name) associated with the team member.

Email Address
team_members.team_member_id.team_member.email_address string

The email address associated with the team member.

Phone Number
team_members.team_member_id.team_member.phone_number string

The team member's phone number, in E.164 format.

Created At
team_members.team_member_id.team_member.created_at string

The timestamp, in RFC 3339 format, describing when the team member was created

Assignment Type
team_members.team_member_id.team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Location IDs
team_members.team_member_id.team_member.assigned_locations.location_ids array of string

Calculate loyalty points

Calculates the points a purchase earns. An application might call this endpoint to show the points that a buyer can earn with the specific purchase.

Parameters

Name Key Required Type Description
Program ID
program_id True string

The identifier of the program.

Order ID
order_id string

The order identifier.

Returns

Name Path Type Description
Points
points integer

The points that the buyer can earn from a specified purchase.

Create booking (Beta)

Creates a booking.

Parameters

Name Key Required Type Description
Customer ID
customer_id string

The ID of this object representing the customer.

Start At
start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

Location ID
location_id string

The identifier of the location.

Duration Minutes
duration_minutes integer

The time span in minutes of an appointment segment.

Team Member ID
team_member_id string

The ID of the TeamMember object representing the team member booked in this segment.

Service Variation ID
service_variation_id string

The ID of the CatalogItemVariation object representing the service booked in this segment.

Service Variation Version
service_variation_version integer

The current version of the item variation representing the service booked in this segment.

Returns

Name Path Type Description
ID
booking.id string

The unique, Square-issued identifier.

Version
booking.version integer

The current version of this object.

Status
booking.status string

The current verification status of this object.

Created At
booking.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
booking.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Location ID
booking.location_id string

The identifier of the location.

Customer ID
booking.customer_id string

The ID of this object representing the customer.

Customer Note
booking.customer_note string

The free-text field for the customer to supply notes about the booking.

Seller Note
booking.seller_note string

The free-text field for the seller to supply notes about the booking.

Start At
booking.start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

Appointment Segment
booking.appointment_segments array of object
Duration Minutes
booking.appointment_segments.duration_minutes integer

The time span in minutes of an appointment segment.

Service Variation ID
booking.appointment_segments.service_variation_id string

The ID of the CatalogItemVariation object representing the service booked in this segment.

Team Member ID
booking.appointment_segments.team_member_id string

The ID of the TeamMember object representing the team member booked in this segment.

Service Variation Version
booking.appointment_segments.service_variation_version integer

The current version of the item variation representing the service booked in this segment.

Errors
errors array of

Create break type

Creates a new BreakType. A BreakType is a template for creating Break objects.

Parameters

Name Key Required Type Description
Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Location ID
location_id string

The identifier of the location.

Break Name
break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Returns

Name Path Type Description
ID
break_type.id string

The unique, Square-issued identifier.

Location ID
break_type.location_id string

The identifier of the location.

Break Name
break_type.break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
break_type.expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
break_type.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
break_type.version integer

The current version of this object.

Created At
break_type.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
break_type.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Create checkout

Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow.

Parameters

Name Key Required Type Description
Location ID
location_id True string

The identifier of the location.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Redirect URL
redirect_url string

For example, if the provided redirect URL is http://www.example.com/order-complete, a successful transaction redirects the customer to:

http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
If you do not provide a redirect URL, Square Checkout displays an order confirmation page on your behalf; however, it is strongly recommended that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this order among orders you have created. If you are unsure whether a particular order was created successfully, you can try it again with the same idempotency key without worrying about creating duplicate orders.

Location ID
location_id string

The query expression to search for availabilities matching the specified seller location IDs.

Customer ID
customer_id string

The ID of the customer associated with the order.

Reference ID
reference_id string

A client-specified ID to associate an entity in another system with this order.

Name
name string

The name of the item.

Quantity
quantity string

The quantity purchased, formatted as a decimal number. Line items with a quantity of 0 are automatically removed when paying for or otherwise completing the order.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Discount UID
discount_uid string

The UID of the discount that the applied discount represents. It must reference a discount present in the order.discounts field. This field is immutable. To change which discounts apply to a line item, you must delete the discount and re-add it as a new OrderLineItemAppliedDiscount.

Tax UID
tax_uid string

The UID of the tax for which this applied tax represents. It must reference a tax present in the order.taxes field. This field is immutable. To change which taxes apply to a line item, delete and add a new OrderLineItemAppliedTax.

UID
uid string

A unique ID.

Type
type string

The type of this object.

Percentage
percentage string

The percentage of the tax, as a string representation of a decimal number.

Scope
scope string

Indicates the level at which the object applies.

UID
uid string

A unique ID.

Type
type string

The type of this object.

Scope
scope string

Indicates the level at which the object applies.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Location ID
location_id string

The identifier for the location.

Description
title string

The description.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Ask for Shipping Address
ask_for_shipping_address boolean

If true, Square Checkout collects shipping information on your behalf and stores that information with the transaction information in the Square Seller Dashboard.

Merchant Support Email
merchant_support_email string

The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the seller. If this value is not set, the confirmation page and email display the primary email address associated with the seller's Square account.

Pre-populate Buyer Email
pre_populate_buyer_email string

If provided, the buyer's email is prepopulated on the checkout page as an editable text field.

Address Line 1
address_line_1 string

The first line of the address.

Address Line 2
address_line_2 string

The second line of the address, if any.

Locality
locality string

The city or town of the address.

Administrative District Level 1
administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
postal_code string

The address's postal code.

Country
country string

The ISO 3166 Alpha-2 country code.

First Name
first_name string

Optional first name when it's representing recipient.

Last Name
last_name string

Optional last name when it's representing recipient.

Returns

Name Path Type Description
ID
checkout.id string

The unique, Square-issued identifier.

Checkout Page URL
checkout.checkout_page_url string

The URL that the buyer's browser should be redirected to after the checkout is completed.

Ask for Shipping Address
checkout.ask_for_shipping_address boolean

If true, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard.

Merchant Support Email
checkout.merchant_support_email string

The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant.

Pre-populate Buyer Email
checkout.pre_populate_buyer_email string

If provided, the buyer's email is pre-populated on the checkout page as an editable text field.

Address Line 1
checkout.pre_populate_shipping_address.address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Address Line 2
checkout.pre_populate_shipping_address.address_line_2 string

The second line of the address, if any.

Locality
checkout.pre_populate_shipping_address.locality string

The city or town of the address.

Administrative District Level 1
checkout.pre_populate_shipping_address.administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
checkout.pre_populate_shipping_address.postal_code string

The address's postal code.

Country
checkout.pre_populate_shipping_address.country string

The address's country, in ISO 3166-1-alpha-2 format.

First Name
checkout.pre_populate_shipping_address.first_name string

Optional first name when it's representing recipient.

Last Name
checkout.pre_populate_shipping_address.last_name string

Optional lsat name when it's representing recipient.

Redirect URL
checkout.redirect_url string

The URL to redirect to after checkout is completed with checkoutId, Square's orderId, transactionId, and referenceId appended as URL parameters. For example, if the provided redirect_url is http://www.example.com/order-complete, a successful transaction redirects the customer to:

http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.

Location ID
checkout.order.location_id string

The query expression to search for availabilities matching the specified seller location IDs.

Customer ID
checkout.order.customer_id string

The ID of the customer associated with the order.

Reference ID
checkout.order.reference_id string

A client-specified ID to associate an entity in another system with this order.

Line Items
checkout.order.line_items array of object
Name
checkout.order.line_items.name string

The name of the line item.

Quantity
checkout.order.line_items.quantity string

The quantity purchased, formatted as a decimal number. Line items with a quantity of 0 are automatically removed when paying for or otherwise completing the order.

Applied Taxes
checkout.order.line_items.applied_taxes array of object
Tax UID
checkout.order.line_items.applied_taxes.tax_uid string

The UID of the tax for which this applied tax represents. It must reference a tax present in the order.taxes field. This field is immutable. To change which taxes apply to a line item, delete and add a new OrderLineItemAppliedTax.

Amount
checkout.order.line_items.applied_taxes.applied_money.amount integer

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.

Currency
checkout.order.line_items.applied_taxes.applied_money.currency string

The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.

Applied Discounts
checkout.order.line_items.applied_discounts array of object
Discount UID
checkout.order.line_items.applied_discounts.discount_uid string

The UID of the discount that the applied discount represents. It must reference a discount present in the order.discounts field. This field is immutable. To change which discounts apply to a line item, you must delete the discount and re-add it as a new OrderLineItemAppliedDiscount.

Amount
checkout.order.line_items.applied_discounts.applied_money.amount integer

The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.

Currency
checkout.order.line_items.applied_discounts.applied_money.currency string

The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.

Amount
checkout.order.line_items.base_price_money.amount integer

The amount.

Currency
checkout.order.line_items.base_price_money.currency string

The currency.

Amount
checkout.order.line_items.total_tax_money.amount integer

The amount.

Currency
checkout.order.line_items.total_tax_money.currency string

The currency.

Amount
checkout.order.line_items.total_discount_money.amount integer

The amount.

Currency
checkout.order.line_items.total_discount_money.currency string

The currency.

Amount
checkout.order.line_items.total_money.amount integer

The amount.

Currency
checkout.order.line_items.total_money.currency string

The currency.

Taxes
checkout.order.taxes array of object
UID
checkout.order.taxes.uid string

A unique ID.

Type
checkout.order.taxes.type string

The type of this object.

Percentage
checkout.order.taxes.percentage string

The percentage of the tax, as a string representation of a decimal number.

Scope
checkout.order.taxes.scope string

Indicates the level at which the object applies.

Discounts
checkout.order.discounts array of object
UID
checkout.order.discounts.uid string

A unique ID.

Type
checkout.order.discounts.type string

The type of this object.

Scope
checkout.order.discounts.scope string

Indicates the level at which the object applies.

Amount
checkout.order.discounts.amount_money.amount integer

The amount.

Currency
checkout.order.discounts.amount_money.currency string

The currency.

Amount
checkout.order.discounts.applied_money.amount integer

The amount.

Currency
checkout.order.discounts.applied_money.currency string

The currency.

Amount
checkout.order.total_money.amount integer

The amount.

Currency
checkout.order.total_money.currency string

The currency.

Amount
checkout.order.total_tax_money.amount integer

The amount.

Currency
checkout.order.total_tax_money.currency string

The currency.

Amount
checkout.order.total_discount_money.amount integer

The amount.

Currency
checkout.order.total_discount_money.currency string

The currency.

Created At
checkout.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Version
checkout.version integer

The current version of this object.

Additional Recipients
checkout.additional_recipients array of object
Location ID
checkout.additional_recipients.location_id string

The location ID for a recipient (other than the merchant) receiving a portion of this tender.

Description
checkout.additional_recipients.title string

The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Amount
checkout.additional_recipients.amount_money.amount integer

The amount.

Currency
checkout.additional_recipients.amount_money.currency string

The currency.

Create device code

Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Parameters

Name Key Required Type Description
Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Name
name string

The name of the object.

Location ID
location_id string

The identifier of the location.

Product Type
product_type string

The targeting product type of the device code.

Returns

Name Path Type Description
ID
device_code.id string

The unique, Square-issued identifier.

Name
device_code.name string

The name of the object.

Code
device_code.code string

The unique code that can be used to login.

Product Type
device_code.product_type string

The targeting product type of the device code.

Location ID
device_code.location_id string

The identifier of the location.

Created At
device_code.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Pair By
device_code.pair_by string

When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Status
device_code.status string

The current verification status of this object.

Status Changed At
device_code.status_changed_at string

When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

Create gift card activity (Beta)

Creates a gift card activity.

Parameters

Name Key Required Type Description
Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Gift Card ID
gift_card_id string

The gift card ID. The ID is not required if a GAN is present.

Type
type string

The type of this object.

Location ID
location_id string

The identifier of the location.

Order ID
order_id string

The ID of the order associated with the activity.

Line Item UID
line_item_uid string

The line_item_uid of the gift card line item in an order.

Returns

Name Path Type Description
ID
gift_card_activity.id string

The unique, Square-issued identifier.

Gift Card ID
gift_card_activity.gift_card_id string

The gift card ID. The ID is not required if a GAN is present.

Gift Card GAN
gift_card_activity.gift_card_gan string

The gift card GAN. The GAN is not required if gift_card_id is present.

Type
gift_card_activity.type string

The type of this object.

Amount
gift_card_activity.gift_card_balance_money.amount integer

The amount.

Currency
gift_card_activity.gift_card_balance_money.currency string

The currency.

Location ID
gift_card_activity.location_id string

The identifier of the location.

Created At
gift_card_activity.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Amount
gift_card_activity.activate_activity_details.amount_money.amount integer

The amount.

Currency
gift_card_activity.activate_activity_details.amount_money.currency string

The currency.

Order ID
gift_card_activity.activate_activity_details.order_id string

The ID of the order associated with the activity.

Line Item UID
gift_card_activity.activate_activity_details.line_item_uid string

The line_item_uid of the gift card line item in an order.

Create location (Beta)

Creates a location.

Parameters

Name Key Required Type Description
Name
name string

The name of the object.

Description
description string

The description.

Facebook URL
facebook_url string

The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.

Address Line 1
address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Administrative District Level 1
administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Locality
locality string

The city or town of the address.

Postal Code
postal_code string

The address's postal code.

Returns

Name Path Type Description
ID
location.id string

The unique, Square-issued identifier.

Name
location.name string

The name of the object.

Address Line 1
location.address.address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Locality
location.address.locality string

The city or town of the address.

Administrative District Level 1
location.address.administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
location.address.postal_code string

The address's postal code.

Capabilities
location.capabilities array of string
Status
location.status string

The current verification status of this object.

Created At
location.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Merchant ID
location.merchant_id string

The ID of the merchant.

Country
location.country string

The ISO 3166 Alpha-2 country code.

Language Code
location.language_code string

The language code, in BCP 47 format.

Currency
location.currency string

The 3-character ISO 4217 currency code.

Type
location.type string

The type of this object.

Description
location.description string

The description.

Website URL
location.website_url string

The website URL of the location.

Twitter Username
location.twitter_username string

The Twitter username of the location without the '@' symbol.

Instagram Username
location.instagram_username string

The Instagram username of the location without the '@' symbol.

Latitude
location.coordinates.latitude float

The latitude of the coordinate expressed in degrees.

Longitude
location.coordinates.longitude float

The longitude of the coordinate expressed in degrees.

MCC
location.mcc string

The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location.

Create loyalty account

Creates a loyalty account.

Parameters

Name Key Required Type Description
Phone Number
phone_number string

The recipient's phone number.

Program ID
program_id string

The Square-assigned ID of the program.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Returns

Name Path Type Description
ID
loyalty_account.id string

The unique, Square-issued identifier.

ID
loyalty_account.mapping.id string

The Square-assigned ID.

Phone Number
loyalty_account.mapping.phone_number string

The recipient's phone number.

Created At
loyalty_account.mapping.created_at string

The timestamp when created, in RFC 3339 format.

Program ID
loyalty_account.program_id string

The Square-assigned ID of the program.

Balance
loyalty_account.balance integer

The available balance.

Lifetime Points
loyalty_account.lifetime_points integer

The total points accrued during the lifetime of the account.

Created At
loyalty_account.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
loyalty_account.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Create loyalty reward

Creates a loyalty reward. After a reward is created, the points are locked and not available for the buyer to redeem another reward.

Parameters

Name Key Required Type Description
Loyalty Account ID
loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Reward Tier ID
reward_tier_id string

The Square-assigned ID of the reward tier used to create the reward.

Order ID
order_id string

The ID of the order.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Returns

Name Path Type Description
ID
reward.id string

The unique, Square-issued identifier.

Status
reward.status string

The current verification status of this object.

Loyalty Account ID
reward.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Reward Tier ID
reward.reward_tier_id string

The Square-assigned ID of the reward tier used to create the reward.

Points
reward.points integer

The number of points added or removed.

Order ID
reward.order_id string

The ID of the order.

Created At
reward.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
reward.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Create mobile authorization code

Generates code to authorize a mobile application to connect to a Square card reader. Authorization codes are one-time-use and expire 60 minutes after being issued.

Parameters

Name Key Required Type Description
Location ID
location_id string

The location identifier.

Returns

Name Path Type Description
Authorization Code
authorization_code string

Generated authorization code that connects a mobile application instance to a Square account.

Expires At
expires_at string

The timestamp when authorization_code expires in RFC 3339 format.

Create shift

Creates a new Shift. A Shift represents a complete workday for a single employee

Parameters

Name Key Required Type Description
Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Team Member ID
team_member_id string

The ID of the team member.

Location ID
location_id string

The identifier of the location.

Start At
start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

End At
end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Start At
start_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

End At
end_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Break Type ID
break_type_id string

The BreakType that this Break was templated on.

Name
name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Expected Duration
expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Returns

Name Path Type Description
ID
shift.id string

The unique, Square-issued identifier.

Team Member ID
shift.team_member_id string

The ID of the team member.

Employee ID
shift.employee_id string

The Square-generated ID of the Employee.

Location ID
shift.location_id string

The identifier of the location.

Timezone
shift.timezone string

The time zone used to interpret calendar dates. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Start At
shift.start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

End At
shift.end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
shift.wage.title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
shift.wage.hourly_rate.amount integer

The amount.

Currency
shift.wage.hourly_rate.currency string

The currency.

Breaks
shift.breaks array of object
ID
shift.breaks.id string

The identifier of the object

Start At
shift.breaks.start_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

End At
shift.breaks.end_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Break Type ID
shift.breaks.break_type_id string

The BreakType that this Break was templated on.

Name
shift.breaks.name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Expected Duration
shift.breaks.expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
shift.breaks.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Status
shift.status string

The current verification status of this object.

Version
shift.version integer

The current version of this object.

Created At
shift.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
shift.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Create team member

Creates a single TeamMember object.

Parameters

Name Key Required Type Description
Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Reference ID
reference_id string

An optional user-defined reference ID.

Status
status string

The current verification status of this object.

Given Name
given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
email_address string

The email address associated with the customer profile.

Phone Number
phone_number string

The 11-digit phone number associated with the customer profile.

Location IDs
location_ids array of string
Assignment Type
assignment_type string

The current assignment type of the team member.

Returns

Name Path Type Description
ID
team_member.id string

The unique, Square-issued identifier.

Reference ID
team_member.reference_id string

An optional user-defined reference ID.

Is Owner
team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_member.status string

The current verification status of this object.

Given Name
team_member.given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
team_member.family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
team_member.email_address string

The email address associated with the customer profile.

Phone Number
team_member.phone_number string

The 11-digit phone number associated with the customer profile.

Assignment Type
team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Location IDs
team_member.assigned_locations.location_ids array of string

Delete break type

Deletes an existing BreakType. A BreakType can be deleted even if it is referenced from a Shift.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

response
object

Delete loyalty reward

Deletes a loyalty reward. Returns the loyalty points back to the loyalty account. You cannot delete a reward that has reached the terminal state (REDEEMED).

Parameters

Name Key Required Type Description
Reward ID
reward_id True string

The identifier of the reward.

Returns

response
object

Delete shift

Deletes a shift

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

response
object

Delete snippet

Removes your snippet from a Square Online site.

Parameters

Name Key Required Type Description
Site ID
site_id True string

The identifier of the site.

Returns

response
object

Get bank account

Returns details of a BankAccount linked to a Square account.

Parameters

Name Key Required Type Description
Bank Account ID
bank_account_id True string

Square-issued ID of the desired BankAccount.

Returns

Name Path Type Description
ID
bank_account.id string

The unique, Square-issued identifier.

Account Number Suffix
bank_account.account_number_suffix string

The last few digits of the account number.

Country
bank_account.country string

The ISO 3166 Alpha-2 country code.

Currency
bank_account.currency string

The 3-character ISO 4217 currency code.

Account Type
bank_account.account_type string

The type of the account.

Holder Name
bank_account.holder_name string

Name of the account holder.

Primary Bank Identification Number
bank_account.primary_bank_identification_number string

Primary identifier for the bank.

Location ID
bank_account.location_id string

The identifier of the location.

Status
bank_account.status string

The current verification status of this object.

Creditable
bank_account.creditable boolean

Indicates whether it is possible for Square to send money to this account.

Debitable
bank_account.debitable boolean

Indicates whether it is possible for Square to take money from this account.

Version
bank_account.version integer

The current version of this object.

Bank Name
bank_account.bank_name string

Name of actual financial institution.

Get bank account by V1 ID

Returns details of a BankAccount identified by V1 bank account ID.

Parameters

Name Key Required Type Description
V1 Bank Account ID
v1_bank_account_id True string

Connect V1 ID of the desired BankAccount.

Returns

Name Path Type Description
ID
bank_account.id string

The unique, Square-issued identifier.

Account Number Suffix
bank_account.account_number_suffix string

The last few digits of the account number.

Country
bank_account.country string

The ISO 3166 Alpha-2 country code.

Currency
bank_account.currency string

The 3-character ISO 4217 currency code.

Account Type
bank_account.account_type string

The type of the account.

Holder Name
bank_account.holder_name string

Name of the account holder.

Primary Bank Identification Number
bank_account.primary_bank_identification_number string

Primary identifier for the bank.

Location ID
bank_account.location_id string

The identifier of the location.

Status
bank_account.status string

The current verification status of this object.

Creditable
bank_account.creditable boolean

Indicates whether it is possible for Square to send money to this account.

Debitable
bank_account.debitable boolean

Indicates whether it is possible for Square to take money from this account.

Version
bank_account.version integer

The current version of this object.

Bank Name
bank_account.bank_name string

Name of actual financial institution.

Get break type

Returns a single BreakType specified by id.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

Name Path Type Description
ID
break_type.id string

The unique, Square-issued identifier.

Location ID
break_type.location_id string

The identifier of the location.

Break Name
break_type.break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
break_type.expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
break_type.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
break_type.version integer

The current version of this object.

Created At
break_type.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
break_type.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Get device code

Retrieves DeviceCode with the associated ID.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

Name Path Type Description
ID
device_code.id string

The unique, Square-issued identifier.

Name
device_code.name string

The name of the object.

Code
device_code.code string

The unique code that can be used to login.

Product Type
device_code.product_type string

The targeting product type of the device code.

Location ID
device_code.location_id string

The identifier of the location.

Created At
device_code.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Pair By
device_code.pair_by string

When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Status
device_code.status string

The current verification status of this object.

Device ID
device_code.device_id string

The ID of the device.

Status Changed At
device_code.status_changed_at string

When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

Get shift

Returns a single Shift specified by id.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

Name Path Type Description
ID
shift.id string

The unique, Square-issued identifier.

Team Member ID
shift.team_member_id string

The ID of the team member.

Employee ID
shift.employee_id string

The Square-generated ID of the Employee.

Location ID
shift.location_id string

The identifier of the location.

Timezone
shift.timezone string

The time zone used to interpret calendar dates. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Start At
shift.start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

End At
shift.end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
shift.wage.title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
shift.wage.hourly_rate.amount integer

The amount.

Currency
shift.wage.hourly_rate.currency string

The currency.

Breaks
shift.breaks array of object
ID
shift.breaks.id string

The identifier of the object

Start At
shift.breaks.start_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

End At
shift.breaks.end_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Break Type ID
shift.breaks.break_type_id string

The BreakType that this Break was templated on.

Name
shift.breaks.name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Expected Duration
shift.breaks.expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
shift.breaks.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Status
shift.status string

The current verification status of this object.

Version
shift.version integer

The current version of this object.

Created At
shift.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
shift.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Get team member wage

Returns a single TeamMemberWage specified by id.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

Name Path Type Description
ID
team_member_wage.id string

The unique, Square-issued identifier.

Team Member ID
team_member_wage.team_member_id string

The ID of the team member.

Title
team_member_wage.title string

The title.

Amount
team_member_wage.hourly_rate.amount integer

The amount.

Currency
team_member_wage.hourly_rate.currency string

The currency.

Links a customer to a gift card

Parameters

Name Key Required Type Description
Gift Card ID
gift_card_id True string

The identifier of the gift card.

Customer ID
customer_id string

The ID of the customer to be linked.

Returns

Name Path Type Description
ID
gift_card.id string

The unique, Square-issued identifier.

Type
gift_card.type string

The type of this object.

GAN Source
gift_card.gan_source string

Indicates whether the gift card account number (GAN) is generated by Square or imported from a non-Square system.

State
gift_card.state string

The current state.

Amount
gift_card.balance_money.amount integer

The amount.

Currency
gift_card.balance_money.currency string

The currency.

GaN
gift_card.gan string

The gift card account number.

Created At
gift_card.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Customer IDs
gift_card.customer_ids array of string

List bank accounts

Returns a list of BankAccount objects linked to a Square account.

Parameters

Name Key Required Type Description
Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Limit
limit integer

Upper limit on the number to return in the response.

Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Returns

Name Path Type Description
Bank Account
bank_accounts array of object
ID
bank_accounts.id string

The unique, Square-issued identifier.

Account Number Suffix
bank_accounts.account_number_suffix string

The last few digits of the account number.

Country
bank_accounts.country string

The ISO 3166 Alpha-2 country code.

Currency
bank_accounts.currency string

The 3-character ISO 4217 currency code.

Account Type
bank_accounts.account_type string

The financial purpose of the associated bank account.

Holder Name
bank_accounts.holder_name string

Name of the account holder. This name must match the name on the targeted bank account record.

Primary Bank Identification Number
bank_accounts.primary_bank_identification_number string

Primary identifier for the bank.

Location ID
bank_accounts.location_id string

The identifier for the location.

Status
bank_accounts.status string

The current verification status of this object.

Creditable
bank_accounts.creditable boolean

Indicates whether it is possible for Square to send money to this bank account.

Debitable
bank_accounts.debitable boolean

Indicates whether it is possible for Square to send money to this bank account.

Version
bank_accounts.version integer

The current version of the object.

Bank Name
bank_accounts.bank_name string

Name of actual financial institution.

List break types

Returns a paginated list of BreakType instances for a business.

Parameters

Name Key Required Type Description
Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Break Types
break_types array of object
ID
break_types.id string

The unique, Square-issued identifier.

Location ID
break_types.location_id string

The identifier for the location.

Break Name
break_types.break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
break_types.expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
break_types.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
break_types.version integer

The current version of the object.

Created At
break_types.created_at string

The event time in ISO 8601 format.

Updated At
break_types.updated_at string

Last modification timestamp in RFC 3339 format

Cursor
cursor string

Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.

List cash drawer shift events

Provides a paginated list of events for a single cash drawer shift.

Parameters

Name Key Required Type Description
Shift ID
shift_id True string

The identifier of the shift.

Location ID
location_id True string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Events
events array of object
ID
events.id string

The unique, Square-issued identifier.

Event Type
events.event_type string

The type of cash drawer shift event.

Amount
events.event_money.amount integer

The amount.

Currency
events.event_money.currency string

The currency.

Created At
events.created_at string

The event time in ISO 8601 format.

Description
events.title string

The description.

List cash drawer shifts

Provides the details for all of the cash drawer shifts for a location in a date range.

Parameters

Name Key Required Type Description
Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Sort Order
sort_order string

Sorts the returned list by when the card was created with the specified order.

Begin Time
begin_time string

The inclusive start time of the query on opened_at, in ISO 8601 format.

End Time
end_time string

The exclusive end date of the query on opened_at, in ISO 8601 format.

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Items
items array of object
ID
items.id string

The unique, Square-issued identifier.

State
items.state string

The current state.

Opened At
items.opened_at string

The shift start time in ISO 8601 format.

Ended At
items.ended_at string

The shift end time in ISO 8601 format.

Closed At
items.closed_at string

The shift close time in ISO 8601 format.

Description
items.title string

The description.

Amount
items.opened_cash_money.amount integer

The amount.

Currency
items.opened_cash_money.currency string

The currency.

Amount
items.expected_cash_money.amount integer

The amount.

Currency
items.expected_cash_money.currency string

The currency.

Amount
items.closed_cash_money.amount integer

The amount.

Currency
items.closed_cash_money.currency string

The currency.

List device codes

Lists all DeviceCodes associated with the merchant.

Parameters

Name Key Required Type Description
Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Product Type
product_type string

If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.

Status
status string

If specified, only returns objects that match the specified statuses.

Returns

Name Path Type Description
Device Codes
device_codes array of object
ID
device_codes.id string

The unique, Square-issued identifier.

Name
device_codes.name string

The name of the object.

Code
device_codes.code string

The unique code that can be used to login.

Product Type
device_codes.product_type string

The targeting product type of the device code.

Location ID
device_codes.location_id string

The identifier for the location.

Created At
device_codes.created_at string

The event time in ISO 8601 format.

Pair By
device_codes.pair_by string

When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Status
device_codes.status string

The current verification status of this object.

Device ID
device_codes.device_id string

The unique id of the device that used this code. Populated when the device is paired.

Status Changed At
device_codes.status_changed_at string

When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

List gift card activities (Beta)

Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

Parameters

Name Key Required Type Description
Gift Card ID
gift_card_id string

If you provide a gift card ID, the endpoint returns activities that belong to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.

Type
type string

If you provide a type, the endpoint returns gift card activities of this type. Otherwise, the endpoint returns all types of gift card activities.

Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Begin Time
begin_time string

The inclusive start time of the query on opened_at, in ISO 8601 format.

End Time
end_time string

The exclusive end date of the query on opened_at, in ISO 8601 format.

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Sort Order
sort_order string

Sorts the returned list by when the card was created with the specified order.

Returns

Name Path Type Description
Gift Card Activities
gift_card_activities array of object
ID
gift_card_activities.id string

The unique, Square-issued identifier.

Type
gift_card_activities.type string

The type of this object.

Location ID
gift_card_activities.location_id string

The identifier for the location.

Created At
gift_card_activities.created_at string

The event time in ISO 8601 format.

Gift Card ID
gift_card_activities.gift_card_id string

The gift card ID. The ID is not required if a GAN is present.

Gift Card GAN
gift_card_activities.gift_card_gan string

The gift card GAN. The GAN is not required if gift_card_id is present.

Amount
gift_card_activities.gift_card_balance_money.amount integer

The amount.

Currency
gift_card_activities.gift_card_balance_money.currency string

The currency.

Amount
gift_card_activities.redeem_activity_details.amount_money.amount integer

The amount.

Currency
gift_card_activities.redeem_activity_details.amount_money.currency string

The currency.

Amount
gift_card_activities.activate_activity_details.amount_money.amount integer

The amount.

Currency
gift_card_activities.activate_activity_details.amount_money.currency string

The currency.

Order ID
gift_card_activities.activate_activity_details.order_id string

The ID of the order associated with the activity.

Line Item UID
gift_card_activities.activate_activity_details.line_item_uid string

The line_item_uid of the gift card line item in an order.

List locations

Provides information of all locations of a business.

Returns

Name Path Type Description
Locations
locations array of object
ID
locations.id string

The unique, Square-issued identifier.

Name
locations.name string

The name of the object.

Address Line 1
locations.address.address_line_1 string

The first line of the address.

Locality
locations.address.locality string

The city or town of the address.

Administrative District Level 1
locations.address.administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
locations.address.postal_code string

The address's postal code.

Country
locations.address.country string

The address's country, in ISO 3166-1-alpha-2 format.

Timezone
locations.timezone string

The time zone used to interpret calendar dates on the invoice, such as due_date. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Capabilities
locations.capabilities array of string
Status
locations.status string

The current verification status of this object.

Created At
locations.created_at string

The event time in ISO 8601 format.

Merchant ID
locations.merchant_id string

The ID of the merchant that owns the location.

Country
locations.country string

The ISO 3166 Alpha-2 country code.

Language Code
locations.language_code string

The language associated with the location, in BCP 47 format.

Currency
locations.currency string

The 3-character ISO 4217 currency code.

Phone Number
locations.phone_number string

The 11-digit phone number associated with the customer profile.

Business Name
locations.business_name string

The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.

List merchants

Returns Merchant information for a given access token.

Parameters

Name Key Required Type Description
Cursor
cursor integer

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Merchant
merchant array of object
ID
merchant.id string

The unique, Square-issued identifier.

Business Name
merchant.business_name string

The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.

Country
merchant.country string

The ISO 3166 Alpha-2 country code.

Language Code
merchant.language_code string

The language associated with the location, in BCP 47 format.

Currency
merchant.currency string

The 3-character ISO 4217 currency code.

Status
merchant.status string

The current verification status of this object.

Main Location ID
merchant.main_location_id string

The ID of the main Location for this merchant.

List sites

Lists the Square Online sites that belong to a seller.

Returns

Name Path Type Description
Sites
sites array of object
ID
sites.id string

The unique, Square-issued identifier.

Site Title
sites.site_title string

The title of the site.

Domain
sites.domain string

The domain of the site (without the protocol).

Is Published
sites.is_published boolean

Indicates whether the site is published.

Created At
sites.created_at string

The event time in ISO 8601 format.

Updated At
sites.updated_at string

Last modification timestamp in RFC 3339 format

List team member booking profiles (Beta)

Lists booking profiles for team members.

Parameters

Name Key Required Type Description
Bookable Only
bookable_only boolean

Indicates whether to include only bookable team members in the returned result (true) or not (false).

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Location ID
location_id string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Returns

Name Path Type Description
Team Member Booking Profiles
team_member_booking_profiles array of object
Team Member ID
team_member_booking_profiles.team_member_id string

The ID of the TeamMember object for the team member associated with the object.

Display Name
team_member_booking_profiles.display_name string

The display name of the team member.

Is Bookable
team_member_booking_profiles.is_bookable boolean

Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (true) or not (false`).

Errors
errors array of

List team member wages

Returns a paginated list of TeamMemberWage instances for a business.

Parameters

Name Key Required Type Description
Team Member ID
team_member_id string

Filter the returned wages to only those that are associated with the specified team member.

Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Team Member Wages
team_member_wages array of object
ID
team_member_wages.id string

The unique, Square-issued identifier.

Team Member ID
team_member_wages.team_member_id string

The ID of the TeamMember object for the team member associated with the object.

Title
team_member_wages.title string

The title of the invoice.

Amount
team_member_wages.hourly_rate.amount integer

The amount.

Currency
team_member_wages.hourly_rate.currency string

The currency.

Cursor
cursor string

Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.

List workweek configs

Returns a list of WorkweekConfig instances for a business.

Parameters

Name Key Required Type Description
Limit
limit integer

Upper limit on the number to return in the response.

Cursor
cursor string

The pagination cursor returned by a previous call to this endpoint.

Returns

Name Path Type Description
Workweek Configs
workweek_configs array of object
ID
workweek_configs.id string

The unique, Square-issued identifier.

Start Of Week
workweek_configs.start_of_week string

The day of the week on which a business week ends for compensation purposes.

Start Of Day Local Time
workweek_configs.start_of_day_local_time string

The local time at which a business week ends. Represented as a string in HH:MM format (HH:MM:SS is also accepted, but seconds are truncated).

Version
workweek_configs.version integer

The current version of the object.

Created At
workweek_configs.created_at string

The event time in ISO 8601 format.

Updated At
workweek_configs.updated_at string

Last modification timestamp in RFC 3339 format

Cursor
cursor string

Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.

Redeem loyalty reward

Redeems a loyalty reward. After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.

Parameters

Name Key Required Type Description
Reward ID
reward_id True string

The identifier of the reward.

Idempotency Key
idempotency_key string

A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID).

Location ID
location_id string

The location identifier.

Returns

Name Path Type Description
ID
event.id string

The unique, Square-issued identifier.

Type
event.type string

The type of this object.

Created At
event.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Loyalty Program ID
event.redeem_reward.loyalty_program_id string

The ID of the loyalty program

Reward ID
event.redeem_reward.reward_id string

The Square-assigned ID of the loyalty reward.

Loyalty Account ID
event.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Location ID
event.location_id string

The identifier of the location.

Source
event.source string

The source.

Retrieve business booking profile (Beta)

Retrieves a seller's booking profile.

Returns

Name Path Type Description
Seller ID
business_booking_profile.seller_id string

The ID of the seller, obtainable using the Merchants API.

Created At
business_booking_profile.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Booking Enabled
business_booking_profile.booking_enabled boolean

Indicates whether the seller is open for booking.

Customer Timezone Choice
business_booking_profile.customer_timezone_choice string

The choice of customer's time zone information of a booking. The Square online booking site and all notifications to customers uses either the seller location’s time zone or the time zone the customer chooses at booking.

Booking Policy
business_booking_profile.booking_policy string

The policy for the seller to automatically accept booking requests (ACCEPT_ALL) or not (REQUIRES_ACCEPTANCE).

Allow User Cancel
business_booking_profile.allow_user_cancel boolean

Indicates whether customers can cancel or reschedule their own bookings (true) or not (false).

Location Types
business_booking_profile.business_appointment_settings.location_types array of string
Alignment Time
business_booking_profile.business_appointment_settings.alignment_time string

The time unit of the service duration for bookings.

Min Booking Tead Time Seconds
business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds integer

The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time.

Max Booking Lead Time Seconds
business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds integer

The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time.

Any Team Member Booking Enabled
business_booking_profile.business_appointment_settings.any_team_member_booking_enabled boolean

Indicates whether a customer can choose from all available time slots and have a staff member assigned automatically (true) or not (false).

Multiple Service Booking Enabled
business_booking_profile.business_appointment_settings.multiple_service_booking_enabled boolean

Indicates whether a customer can book multiple services in a single online booking.

Amount
business_booking_profile.business_appointment_settings.cancellation_fee_money.amount string

The amount of money, in the smallest denomination of the currency indicated by currency

Currency
business_booking_profile.business_appointment_settings.cancellation_fee_money.currency string

The type of currency, in ISO 4217 format.

Cancellation Policy
business_booking_profile.business_appointment_settings.cancellation_policy string

The cancellation policy adopted by the seller.

Skip Booking Flow Staff Selection
business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection boolean

Indicates whether customers has an assigned staff member (true) or can select s staff member of their choice (false).

Errors
errors array of

Retrieve cash drawer shift

Provides the summary details for a single cash drawer shift.

Parameters

Name Key Required Type Description
Shift ID
shift_id True string

The identifier of the shift.

Location ID
location_id True string

You can specify this optional filter to retrieve only the records belonging to a specific location.

Returns

Name Path Type Description
ID
cash_drawer_shift.id string

The unique, Square-issued identifier.

State
cash_drawer_shift.state string

The current state.

Opened At
cash_drawer_shift.opened_at string

The time when the shift began, in ISO 8601 format.

Ended At
cash_drawer_shift.ended_at string

The time when the shift ended, in ISO 8601 format.

Closed At
cash_drawer_shift.closed_at string

The time when closed, in ISO 8601 format.

Opening Employee ID
cash_drawer_shift.opening_employee_id string

The ID of the employee that started the cash drawer shift.

Ending Employee ID
cash_drawer_shift.ending_employee_id string

The ID of the employee that ended the cash drawer shift.

Closing Employee ID
cash_drawer_shift.closing_employee_id string

The ID of the employee that closed the cash drawer shift by auditing the cash drawer contents.

Description
cash_drawer_shift.description string

The description.

Amount
cash_drawer_shift.opened_cash_money.amount integer

The amount.

Currency
cash_drawer_shift.opened_cash_money.currency string

The currency.

Amount
cash_drawer_shift.cash_payment_money.amount integer

The amount.

Currency
cash_drawer_shift.cash_payment_money.currency string

The currency.

Amount
cash_drawer_shift.cash_refunds_money.amount integer

The amount.

Currency
cash_drawer_shift.cash_refunds_money.currency string

The currency.

Amount
cash_drawer_shift.cash_paid_in_money.amount integer

The amount.

Currency
cash_drawer_shift.cash_paid_in_money.currency string

The currency.

Amount
cash_drawer_shift.cash_paid_out_money.amount integer

The amount.

Currency
cash_drawer_shift.cash_paid_out_money.currency string

The currency.

Amount
cash_drawer_shift.expected_cash_money.amount integer

The amount.

Currency
cash_drawer_shift.expected_cash_money.currency string

The currency.

Amount
cash_drawer_shift.closed_cash_money.amount integer

The amount.

Currency
cash_drawer_shift.closed_cash_money.currency string

The currency.

Name
cash_drawer_shift.device.name string

The name.

Retrieve gift card (Beta)

Retrieves a gift card using its ID.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Returns

Name Path Type Description
ID
gift_card.id string

The unique, Square-issued identifier.

Type
gift_card.type string

The type of this object.

GAN Source
gift_card.gan_source string

Indicates whether the gift card account number (GAN) is generated by Square or imported from a non-Square system.

State
gift_card.state string

The current state.

Amount
gift_card.balance_money.amount integer

The amount.

Currency
gift_card.balance_money.currency string

The currency.

GaN
gift_card.gan string

The gift card account number.

Created At
gift_card.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Retrieve gift card from GAN (Beta)

Retrieves a gift card using the gift card account number (GAN).

Parameters

Name Key Required Type Description
GaN
gan string

The gift card account number.

Returns

Name Path Type Description
ID
gift_card.id string

The unique, Square-issued identifier.

Type
gift_card.type string

The type of this object.

GAN Source
gift_card.gan_source string

Indicates whether the gift card account number (GAN) is generated by Square or imported from a non-Square system.

State
gift_card.state string

The current state.

Amount
gift_card.balance_money.amount integer

The amount.

Currency
gift_card.balance_money.currency string

The currency.

GaN
gift_card.gan string

The gift card account number.

Created At
gift_card.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Retrieve gift card from nonce (Beta)

Retrieves a gift card using a nonce (a secure token) that represents the gift card.

Parameters

Name Key Required Type Description
Nonce
nonce string

The nonce of the gift card to retrieve.

Returns

Name Path Type Description
ID
gift_card.id string

The unique, Square-issued identifier.

Type
gift_card.type string

The type of this object.

GAN Source
gift_card.gan_source string

Indicates whether the gift card account number (GAN) is generated by Square or imported from a non-Square system.

State
gift_card.state string

The current state.

Amount
gift_card.balance_money.amount integer

The amount.

Currency
gift_card.balance_money.currency string

The currency.

GaN
gift_card.gan string

The gift card account number.

Created At
gift_card.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Retrieve location

Retrieves details of a location. You can specify "main" as the location ID to retrieve details of the main location.

Parameters

Name Key Required Type Description
Location ID
location_id True string

The identifier of the location.

Returns

Name Path Type Description
ID
location.id string

The unique, Square-issued identifier.

Name
location.name string

The name of the object.

Address Line 1
location.address.address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Locality
location.address.locality string

The city or town of the address.

Administrative District Level 1
location.address.administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
location.address.postal_code string

The address's postal code.

Country
location.address.country string

The address's country, in ISO 3166-1-alpha-2 format.

Timezone
location.timezone string

The time zone used to interpret calendar dates. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Capabilities
location.capabilities array of string
Status
location.status string

The current verification status of this object.

Created At
location.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Merchant ID
location.merchant_id string

The ID of the merchant.

Country
location.country string

The ISO 3166 Alpha-2 country code.

Language Code
location.language_code string

The language code, in BCP 47 format.

Currency
location.currency string

The 3-character ISO 4217 currency code.

Phone Number
location.phone_number string

The 11-digit phone number associated with the customer profile.

Business Name
location.business_name string

The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.

Retrieve loyalty account

Retrieves a loyalty account.

Parameters

Name Key Required Type Description
Account ID
account_id True string

The identifier of the account.

Returns

Name Path Type Description
ID
loyalty_account.id string

The unique, Square-issued identifier.

ID
loyalty_account.mapping.id string

The Square-assigned ID.

Phone Number
loyalty_account.mapping.phone_number string

The recipient's phone number.

Created At
loyalty_account.mapping.created_at string

The timestamp when created, in RFC 3339 format.

Program ID
loyalty_account.program_id string

The Square-assigned ID of the program.

Balance
loyalty_account.balance integer

The available balance.

Lifetime Points
loyalty_account.lifetime_points integer

The total points accrued during the lifetime of the account.

Customer ID
loyalty_account.customer_id string

The ID of this object representing the customer.

Created At
loyalty_account.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
loyalty_account.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Retrieve loyalty program

Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword main. Loyalty programs define how buyers can earn points and redeem points for rewards.

Parameters

Name Key Required Type Description
Program ID
program_id True string

The identifier of the program.

Returns

Name Path Type Description
ID
program.id string

The unique, Square-issued identifier.

Status
program.status string

The current verification status of this object.

Reward Tiers
program.reward_tiers array of object
ID
program.reward_tiers.id string

The identifier of the object

Points
program.reward_tiers.points integer

The number of points accumulated by the event.

Name
program.reward_tiers.name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Scope
program.reward_tiers.definition.scope string

Indicates the level at which the object applies.

Discount Type
program.reward_tiers.definition.discount_type string

The type of discount the reward tier offers.

Percentage Discount
program.reward_tiers.definition.percentage_discount string

The fixed percentage of the discount.

Created At
program.reward_tiers.created_at string

The timestamp when created, in RFC 3339 format.

Object ID
program.reward_tiers.pricing_rule_reference.object_id string

The ID of the referenced object.

Catalog Version
program.reward_tiers.pricing_rule_reference.catalog_version string

The version of the object.

One
program.terminology.one string

A singular unit for a point (for example, 1 point is called 1 star).

Other
program.terminology.other string

A plural unit for point (for example, 10 points is called 10 stars).

Location IDs
program.location_ids array of string
Created At
program.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
program.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Accrual Rules
program.accrual_rules array of object
Accrual Type
program.accrual_rules.accrual_type string

The type of the accrual rule that defines how buyers can earn points.

Points
program.accrual_rules.points integer

The number of points accumulated by the event.

Amount
program.accrual_rules.spend_amount_money.amount integer

The amount.

Excluded Category IDs
program.accrual_rules.excluded_category_ids array of string
Excluded Item Variation IDs
program.accrual_rules.excluded_item_variation_ids array of string

Retrieve loyalty reward

Retrieves a loyalty reward.

Parameters

Name Key Required Type Description
Reward ID
reward_id True string

The identifier of the reward.

Returns

Name Path Type Description
ID
reward.id string

The unique, Square-issued identifier.

Status
reward.status string

The current verification status of this object.

Loyalty Account ID
reward.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Reward Tier ID
reward.reward_tier_id string

The Square-assigned ID of the reward tier used to create the reward.

Points
reward.points integer

The number of points added or removed.

Created At
reward.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
reward.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Redeemed At
reward.redeemed_at string

The timestamp when the reward was redeemed, in RFC 3339 format.

Retrieve merchant

Retrieve a Merchant object for the given merchant_id.

Parameters

Name Key Required Type Description
Merchant ID
merchant_id True string

The identifier of the merchant.

Returns

Name Path Type Description
ID
merchant.id string

The unique, Square-issued identifier.

Business Name
merchant.business_name string

The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.

Country
merchant.country string

The ISO 3166 Alpha-2 country code.

Language Code
merchant.language_code string

The language code, in BCP 47 format.

Currency
merchant.currency string

The 3-character ISO 4217 currency code.

Status
merchant.status string

The current verification status of this object.

Main Location ID
merchant.main_location_id string

The ID of the main Location for this merchant.

Retrieve snippet

Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.

Parameters

Name Key Required Type Description
Site ID
site_id True string

The identifier of the site.

Returns

Name Path Type Description
ID
snippet.id string

The unique, Square-issued identifier.

Site ID
snippet.site_id string

The ID of the site that contains the snippet.

Content
snippet.content string

The snippet code, which can contain valid HTML, JavaScript, or both.

Created At
snippet.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
snippet.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Retrieve team member

Retrieves a TeamMember object for the given TeamMember id.

Parameters

Name Key Required Type Description
Team Member ID
team_member_id True string

The identifier of the team member.

Returns

Name Path Type Description
ID
team_member.id string

The unique, Square-issued identifier.

Reference ID
team_member.reference_id string

An optional user-defined reference ID.

Is Owner
team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_member.status string

The current verification status of this object.

Given Name
team_member.given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
team_member.family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
team_member.email_address string

The email address associated with the customer profile.

Phone Number
team_member.phone_number string

The 11-digit phone number associated with the customer profile.

Created At
team_member.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
team_member.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Assignment Type
team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Location IDs
team_member.assigned_locations.location_ids array of string

Retrieve wage setting

Retrieves a WageSetting object for a team member specified by TeamMember id.

Parameters

Name Key Required Type Description
Team Member ID
team_member_id True string

The identifier of the team member.

Returns

Name Path Type Description
Team Member ID
wage_setting.team_member_id string

The ID of the team member.

Job Assignments
wage_setting.job_assignments array of object
Job Title
wage_setting.job_assignments.job_title string

The title of the job.

Pay Type
wage_setting.job_assignments.pay_type string

The current pay type for the job assignment used to calculate the pay amount in a pay period.

Amount
wage_setting.job_assignments.hourly_rate.amount integer

The amount.

Currency
wage_setting.job_assignments.hourly_rate.currency string

The currency.

Amount
wage_setting.job_assignments.annual_rate.amount integer

The amount.

Currency
wage_setting.job_assignments.annual_rate.currency string

The currency.

Weekly Hours
wage_setting.job_assignments.weekly_hours integer

The planned hours per week for the job. Set if the job PayType is SALARY.

Is Overtime Exempt
wage_setting.is_overtime_exempt boolean

Whether the team member is exempt from the overtime rules of the seller's country.

Version
wage_setting.version integer

The current version of this object.

Created At
wage_setting.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
wage_setting.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Search availability (Beta)

Searches for availabilities for booking.

Parameters

Name Key Required Type Description
Start At
start_at string

A datetime value in RFC 3339 format indicating when the time range starts.

End At
end_at string

A datetime value in RFC 3339 format indicating when the time range ends.

Location ID
location_id string

The query expression to search for availabilities matching the specified seller location IDs.

Service Variation ID
service_variation_id string

The ID of the CatalogItemVariation representing the service booked in this segment.

Any
any array of string

Returns

Name Path Type Description
Availabilities
availabilities array of object
Start At
availabilities.start_at string

The RFC 3339 timestamp specifying the beginning time of the slot available.

Location ID
availabilities.location_id string

The identifier for the location.

Appointment Segments
availabilities.appointment_segments array of object
Duration Minutes
availabilities.appointment_segments.duration_minutes integer

The time span in minutes of an appointment segment.

Team Member ID
availabilities.appointment_segments.team_member_id string

The ID of the TeamMember object representing the team member booked in this segment.

Service Variation ID
availabilities.appointment_segments.service_variation_id string

The ID of the CatalogItemVariation object representing the service booked in this segment.

Service Variation Version
availabilities.appointment_segments.service_variation_version integer

The current version of the item variation representing the service booked in this segment.

Errors
errors array of

Search loyalty accounts

Searches for loyalty accounts in a loyalty program.

Parameters

Name Key Required Type Description
Limit
limit integer

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns

Name Path Type Description
Loyalty Accounts
loyalty_accounts array of object
ID
loyalty_accounts.id string

The unique, Square-issued identifier.

ID
loyalty_accounts.mapping.id string

The identifier of the object

Phone Number
loyalty_accounts.mapping.phone_number string

The recipient's phone number.

Created At
loyalty_accounts.mapping.created_at string

The timestamp when created, in RFC 3339 format.

Program ID
loyalty_accounts.program_id string

The Square-assigned ID of the loyalty program to which the account belongs.

Balance
loyalty_accounts.balance integer

The available point balance in the loyalty account.

Lifetime Points
loyalty_accounts.lifetime_points integer

The total points accrued during the lifetime of the account.

Customer ID
loyalty_accounts.customer_id string

The Square-assigned ID of the customer that is associated with the account.

Created At
loyalty_accounts.created_at string

The event time in ISO 8601 format.

Updated At
loyalty_accounts.updated_at string

Last modification timestamp in RFC 3339 format

Cursor
cursor string

Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.

Search loyalty events

Searches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in the point balance (for example, points earned, points redeemed, and points expired) is recorded in the ledger. Using this endpoint, you can search the ledger for events.

Parameters

Name Key Required Type Description
Order ID
order_id string

The order identifier.

Limit
limit integer

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns

Name Path Type Description
Events
events array of object
ID
events.id string

The unique, Square-issued identifier.

Type
events.type string

The type of this object.

Created At
events.created_at string

The event time in ISO 8601 format.

Loyalty Program ID
events.accumulate_points.loyalty_program_id string

The ID of the loyalty program

Points
events.accumulate_points.points integer

The number of points accumulated by the event.

Order ID
events.accumulate_points.order_id string

The ID of the order associated with the activity.

Loyalty Account ID
events.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Location ID
events.location_id string

The identifier for the location.

Source
events.source string

Defines whether the event was generated by the Square Point of Sale.

Loyalty Program ID
events.redeem_reward.loyalty_program_id string

The ID of the loyalty program

Reward ID
events.redeem_reward.reward_id string

The ID of the redeemed loyalty reward.

Order ID
events.redeem_reward.order_id string

The ID of the order associated with the activity.

Loyalty Program ID
events.create_reward.loyalty_program_id string

The ID of the loyalty program

Reward ID
events.create_reward.reward_id string

The ID of the redeemed loyalty reward.

Points
events.create_reward.points integer

The number of points accumulated by the event.

Search loyalty rewards

Searches for loyalty rewards in a loyalty account.

Parameters

Name Key Required Type Description
Loyalty Account ID
loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Limit
limit integer

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns

Name Path Type Description
Rewards
rewards array of object
ID
rewards.id string

The unique, Square-issued identifier.

Status
rewards.status string

The current verification status of this object.

Loyalty Account ID
rewards.loyalty_account_id string

The ID of the loyalty account in which the event occurred.

Reward Tier ID
rewards.reward_tier_id string

The Square-assigned ID of the reward tier used to create the reward.

Points
rewards.points integer

The number of loyalty points used for the reward.

Order ID
rewards.order_id string

The ID of the order.

Created At
rewards.created_at string

The event time in ISO 8601 format.

Updated At
rewards.updated_at string

Last modification timestamp in RFC 3339 format

Redeemed At
rewards.redeemed_at string

The timestamp when the reward was redeemed, in RFC 3339 format.

Search shifts

Returns a paginated list of Shift records for a business.

Parameters

Name Key Required Type Description
Start Date
start_date string

A string in YYYY-MM-DD format, such as 2017-10-31, per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive).

End Date
end_date string

A string in YYYY-MM-DD format, such as 2017-10-31, per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive).

Match Shifts By
match_shifts_by string

The strategy on which the dates are applied.

Default Timezone
default_timezone string

Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone.

Limit
limit integer

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns

Name Path Type Description
Shifts
shifts array of object
ID
shifts.id string

The unique, Square-issued identifier.

Team Member ID
shifts.team_member_id string

The ID of the TeamMember object for the team member associated with the object.

Location ID
shifts.location_id string

The identifier for the location.

Timezone
shifts.timezone string

The time zone used to interpret calendar dates on the invoice, such as due_date. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Start At
shifts.start_at string

The RFC 3339 timestamp specifying the beginning time of the slot available.

End At
shifts.end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
shifts.wage.title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
shifts.wage.hourly_rate.amount integer

The amount.

Currency
shifts.wage.hourly_rate.currency string

The currency.

Breaks
shifts.breaks array of object
ID
shifts.breaks.id string

An identifier to reference this object.

Start At
shifts.breaks.start_at string

A datetime value in RFC 3339 format indicating when the time range starts.

End At
shifts.breaks.end_at string

A datetime value in RFC 3339 format indicating when the time range ends.

Break Type ID
shifts.breaks.break_type_id string

The BreakType that this Break was templated on.

Name
shifts.breaks.name string

A human-readable name.

Expected Duration
shifts.breaks.expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
shifts.breaks.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Status
shifts.status string

The current verification status of this object.

Version
shifts.version integer

The current version of the object.

Created At
shifts.created_at string

The event time in ISO 8601 format.

Updated At
shifts.updated_at string

Last modification timestamp in RFC 3339 format

Search team members

Returns a paginated list of TeamMember objects for a business.

Parameters

Name Key Required Type Description
Location IDs
location_ids array of string
Status
status string

The current status.

Limit
limit integer

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Returns

Name Path Type Description
Team Members
team_members array of object
ID
team_members.id string

The unique, Square-issued identifier.

Reference ID
team_members.reference_id string

An optional second ID used to associate the customer profile with an entity in another system.

Is Owner
team_members.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_members.status string

The current verification status of this object.

Given Name
team_members.given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
team_members.family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
team_members.email_address string

The email address associated with the customer profile.

Created At
team_members.created_at string

The event time in ISO 8601 format.

Updated At
team_members.updated_at string

Last modification timestamp in RFC 3339 format

Assignment Type
team_members.assigned_locations.assignment_type string

The current assignment type of the team member.

Phone Number
team_members.phone_number string

The 11-digit phone number associated with the customer profile.

Cursor
cursor string

Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.

Unlinks a customer from a gift card.

Parameters

Name Key Required Type Description
Gift Card ID
gift_card_id True string

The identifier of the gift card.

Customer ID
customer_id string

The ID of the customer to be linked.

Returns

Name Path Type Description
ID
gift_card.id string

The unique, Square-issued identifier.

Type
gift_card.type string

The type of this object.

GAN Source
gift_card.gan_source string

Indicates whether the gift card account number (GAN) is generated by Square or imported from a non-Square system.

State
gift_card.state string

The current state.

Amount
gift_card.balance_money.amount integer

The amount.

Currency
gift_card.balance_money.currency string

The currency.

GaN
gift_card.gan string

The gift card account number.

Created At
gift_card.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Update break type

Updates an existing BreakType.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Location ID
location_id string

The identifier of the location.

Break Name
break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
version integer

The current version of this object.

Returns

Name Path Type Description
ID
break_type.id string

The unique, Square-issued identifier.

Location ID
break_type.location_id string

The identifier of the location.

Break Name
break_type.break_name string

A human-readable name for this type of break. The name is displayed to employees in Square products.

Expected Duration
break_type.expected_duration string

The expected length of this break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precision less than minutes is truncated.

Is Paid
break_type.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
break_type.version integer

The current version of this object.

Created At
break_type.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
break_type.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Update location (Beta)

Updates a location.

Parameters

Name Key Required Type Description
Location ID
location_id True string

The identifier of the location.

Name
name string

The name of the object.

Description
description string

The description.

Facebook URL
facebook_url string

The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.

Twitter Username
twitter_username string

The Twitter username of the location without the '@' symbol.

Instagram Username
instagram_username string

The Instagram username of the location without the '@' symbol.

Address Line 1
address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Administrative District Level 1
administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Locality
locality string

The city or town of the address.

Postal Code
postal_code string

The address's postal code.

Day Of Week
day_of_week string

The day of week for this time period.

Start Local Time
start_local_time string

The start time of a business hours period, specified in local time using partial-time RFC 3339 format.

End Local Time
end_local_time string

The end time of a business hours period, specified in local time using partial-time RFC 3339 format.

Returns

Name Path Type Description
ID
location.id string

The unique, Square-issued identifier.

Name
location.name string

The name of the object.

Address Line 1
location.address.address_line_1 string

The first line of the address. Fields that start with address_line provide the address's most specific details, like street number, street name, and building name.

Locality
location.address.locality string

The city or town of the address.

Administrative District Level 1
location.address.administrative_district_level_1 string

A civil entity within the address's country. In the US, this is the state.

Postal Code
location.address.postal_code string

The address's postal code.

Timezone
location.timezone string

The time zone used to interpret calendar dates. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Capabilities
location.capabilities array of string
Status
location.status string

The current verification status of this object.

Created At
location.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Merchant ID
location.merchant_id string

The ID of the merchant.

Country
location.country string

The ISO 3166 Alpha-2 country code.

Language Code
location.language_code string

The language code, in BCP 47 format.

Currency
location.currency string

The 3-character ISO 4217 currency code.

Phone Number
location.phone_number string

The 11-digit phone number associated with the customer profile.

Business Name
location.business_name string

The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.

Type
location.type string

The type of this object.

Website URL
location.website_url string

The website URL of the location.

Periods
location.business_hours.periods array of object
Day Of Week
location.business_hours.periods.day_of_week string

The day of week for this time period.

Start Local Time
location.business_hours.periods.start_local_time string

The start time of a business hours period, specified in local time using partial-time RFC 3339 format.

End Local Time
location.business_hours.periods.end_local_time string

The end time of a business hours period, specified in local time using partial-time RFC 3339 format.

Business Email
location.business_email string

The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.

Description
location.description string

The description.

Twitter Username
location.twitter_username string

The Twitter username of the location without the '@' symbol.

Instagram Username
location.instagram_username string

The Instagram username of the location without the '@' symbol.

Latitude
location.coordinates.latitude float

The latitude of the coordinate expressed in degrees.

Longitude
location.coordinates.longitude float

The longitude of the coordinate expressed in degrees.

MCC
location.mcc string

The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location.

Update shift

Updates an existing Shift.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Team Member ID
team_member_id string

The ID of the team member.

Location ID
location_id string

The identifier of the location.

Start At
start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

End At
end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
amount integer

The amount.

Currency
currency string

The currency.

ID
id string

The identifier of the object

Start At
start_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

End At
end_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Break Type ID
break_type_id string

The BreakType that this Break was templated on.

Name
name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Expected Duration
expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Version
version integer

The current version of this object.

Returns

Name Path Type Description
ID
shift.id string

The unique, Square-issued identifier.

Team Member ID
shift.team_member_id string

The ID of the team member.

Employee ID
shift.employee_id string

The Square-generated ID of the Employee.

Location ID
shift.location_id string

The identifier of the location.

Timezone
shift.timezone string

The time zone used to interpret calendar dates. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.

Start At
shift.start_at string

The timestamp specifying the starting time of this object, in RFC 3339 format.

End At
shift.end_at string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

Title
shift.wage.title string

The name of the job performed during this shift. Square labor-reporting UIs might group shifts together by title.

Amount
shift.wage.hourly_rate.amount integer

The amount.

Currency
shift.wage.hourly_rate.currency string

The currency.

Breaks
shift.breaks array of object
ID
shift.breaks.id string

The identifier of the object

Start At
shift.breaks.start_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

End At
shift.breaks.end_at string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Break Type ID
shift.breaks.break_type_id string

The BreakType that this Break was templated on.

Name
shift.breaks.name string

The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.

Expected Duration
shift.breaks.expected_duration string

The expected length of the break. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Is Paid
shift.breaks.is_paid boolean

Whether this break counts towards time worked for compensation purposes.

Status
shift.status string

The current verification status of this object.

Version
shift.version integer

The current version of this object.

Created At
shift.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
shift.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Update team member

Updates a single TeamMember object.

Parameters

Name Key Required Type Description
Team Member ID
team_member_id True string

The identifier of the team member.

Reference ID
reference_id string

An optional user-defined reference ID.

Status
status string

The current verification status of this object.

Given Name
given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
email_address string

The email address associated with the customer profile.

Phone Number
phone_number string

The 11-digit phone number associated with the customer profile.

Location IDs
location_ids array of string
Assignment Type
assignment_type string

The current assignment type of the team member.

Returns

Name Path Type Description
ID
team_member.id string

The unique, Square-issued identifier.

Reference ID
team_member.reference_id string

An optional user-defined reference ID.

Is Owner
team_member.is_owner boolean

Whether the team member is the owner of the Square account.

Status
team_member.status string

The current verification status of this object.

Given Name
team_member.given_name string

The given (i.e., first) name associated with the customer profile.

Family Name
team_member.family_name string

The family (i.e., last) name associated with the customer profile.

Email Address
team_member.email_address string

The email address associated with the customer profile.

Phone Number
team_member.phone_number string

The 11-digit phone number associated with the customer profile.

Created At
team_member.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Assignment Type
team_member.assigned_locations.assignment_type string

The current assignment type of the team member.

Location IDs
team_member.assigned_locations.location_ids array of string

Update wage setting

Creates or updates a WageSetting object.

Parameters

Name Key Required Type Description
Team Member ID
team_member_id True string

The identifier of the team member.

Is Overtime Exempt
is_overtime_exempt boolean

Whether the team member is exempt from the overtime rules of the seller's country.

Job Title
job_title string

The title of the job.

Pay Type
pay_type string

The current pay type for the job assignment used to calculate the pay amount in a pay period.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Weekly Hours
weekly_hours integer

The planned hours per week for the job. Set if the job PayType is SALARY.

Amount
amount integer

The amount.

Currency
currency string

The currency.

Returns

Name Path Type Description
Team Member ID
wage_setting.team_member_id string

The ID of the team member.

Job Assignments
wage_setting.job_assignments array of object
Job Title
wage_setting.job_assignments.job_title string

The title of the job.

Pay Type
wage_setting.job_assignments.pay_type string

The current pay type for the job assignment used to calculate the pay amount in a pay period.

Amount
wage_setting.job_assignments.hourly_rate.amount integer

The amount.

Currency
wage_setting.job_assignments.hourly_rate.currency string

The currency.

Amount
wage_setting.job_assignments.annual_rate.amount integer

The amount.

Currency
wage_setting.job_assignments.annual_rate.currency string

The currency.

Weekly Hours
wage_setting.job_assignments.weekly_hours integer

The planned hours per week for the job. Set if the job PayType is SALARY.

Is Overtime Exempt
wage_setting.is_overtime_exempt boolean

Whether the team member is exempt from the overtime rules of the seller's country.

Version
wage_setting.version integer

The current version of this object.

Created At
wage_setting.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
wage_setting.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Update workweek config

Updates a WorkweekConfig.

Parameters

Name Key Required Type Description
ID
id True string

The identifier.

Start Of Week
start_of_week string

The day of the week on which a business week ends for compensation purposes.

Start Of Day Local Time
start_of_day_local_time string

The local time at which a business week ends. Represented as a string in HH:MM format (HH:MM:SS is also accepted, but seconds are truncated).

Version
version integer

The current version of this object.

Returns

Name Path Type Description
ID
workweek_config.id string

The unique, Square-issued identifier.

Start Of Week
workweek_config.start_of_week string

The day of the week on which a business week ends for compensation purposes.

Start Of Day Local Time
workweek_config.start_of_day_local_time string

The local time at which a business week ends. Represented as a string in HH:MM format (HH:MM:SS is also accepted, but seconds are truncated).

Version
workweek_config.version integer

The current version of this object.

Created At
workweek_config.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
workweek_config.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Upsert snippet

Adds a snippet to a Square Online site or updates the existing snippet on the site. The snippet code is appended to the end of the head element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site.

Parameters

Name Key Required Type Description
Site ID
site_id True string

The identifier of the site.

Content
content string

The snippet code, which can contain valid HTML, JavaScript, or both.

Returns

Name Path Type Description
ID
snippet.id string

The unique, Square-issued identifier.

Site ID
snippet.site_id string

The ID of the site that contains the snippet.

Content
snippet.content string

The snippet code, which can contain valid HTML, JavaScript, or both.

Created At
snippet.created_at string

The timestamp specifying the creation time of this object, in RFC 3339 format.

Updated At
snippet.updated_at string

The timestamp specifying the most recent update time of this object, in RFC 3339 format.

Definitions

object

This is the type 'object'.