Square API

Object Index

You are viewing an old version of the API

2019-12-17

Version 2019-12-17

• All Versions

AdditionalRecipient

Represents an additional recipient other than the merchant receiving a portion of this tender

AdditionalRecipientReceivable

Represents a monetary distribution of part of a Transaction's amount for Transactions which included additional recipients

AdditionalRecipientReceivableRefund

A refund of an AdditionalRecipientReceivable

Address

Represents a physical address

BalancePaymentDetails

Reflects the current status of a balance payment

Break

A record of an employee's break during a shift

BreakType

A defined break template that sets an expectation for possible Break instances on a Shift

BusinessHours

Represents the hours of operation for a business location

BusinessHoursPeriod

Represents a period of time during which a business location is open

Card

Represents the payment details of a card to be used for payments

CardPaymentDetails

Reflects the current status of a card payment

CashDrawerDevice

CashDrawerShift

This model gives the details of a cash drawer shift

CashDrawerShiftEvent

CashDrawerShiftSummary

The summary of a closed cash drawer shift

CashPaymentDetails

Additional details about CASH type payments

CatalogCategory

A category to which a CatalogItem belongs in the Catalog object model

CatalogDiscount

A discount in the Catalog object model

CatalogIdMapping

A mapping between a client-supplied temporary ID and a permanent server ID

CatalogImage

An image file to use in Square catalogs

CatalogInfoResponseLimits

CatalogItem

An item ie product family in the Catalog object model

CatalogItemModifierListInfo

Controls the properties of a CatalogModifierList as it applies to this CatalogItem

CatalogItemOption

A group of variations for a CatalogItem

CatalogItemOptionForItem

A list of item option values that can be assigned to item variations

CatalogItemOptionValue

An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values

CatalogItemOptionValueForItemVariation

A CatalogItemOptionValue links an item variation to an item option as an item option value

CatalogItemVariation

An item variation ie product in the Catalog object model

CatalogMeasurementUnit

Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities

CatalogModifier

A modifier in the Catalog object model

CatalogModifierList

A modifier list in the Catalog object model

CatalogModifierOverride

CatalogObject

The wrapper object for object types in the Catalog data model

CatalogObjectBatch

A batch of catalog objects

CatalogPricingRule

Defines how prices are modified or set for items that match the pricing rule during the active time period

CatalogProductSet

Represents a collection of catalog objects for the purpose of applying a PricingRule

CatalogQuery

A query to be applied to a SearchCatalogObjectsRequest

CatalogQueryCustomAttributeUsage

CatalogQueryExact

CatalogQueryFilteredItems

CatalogQueryFilteredItemsCustomAttributeFilter

CatalogQueryItemsForItemOptions

CatalogQueryItemsForModifierList

CatalogQueryItemsForTax

CatalogQueryItemVariationsForItemOptionValues

CatalogQueryPrefix

CatalogQueryRange

CatalogQuerySortedAttribute

CatalogQueryText

CatalogTax

A tax in the Catalog object model

CatalogTimePeriod

Represents a time period - either a single period or a repeating period

CatalogV1Id

An Items Connect V1 object ID along with its associated location ID

CatalogVersionUpdatedWebhook

CatalogVersionUpdatedWebhookCatalogVersion

CatalogVersionUpdatedWebhookData

CatalogVersionUpdatedWebhookObject

ChargeRequestAdditionalRecipient

Represents an additional recipient other than the merchant entitled to a portion of the tender

Checkout

Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareupcom

Coordinates

Latitude and longitude coordinates

CreateOrderRequestDiscount

Please use the OrderLineItemDiscount type in the order field of CreateOrderRequest instead

CreateOrderRequestLineItem

Please use the OrderLineItem type in the order field of CreateOrderRequest instead

CreateOrderRequestModifier

Please use the OrderLineItemModifier type instead

CreateOrderRequestTax

Please use the OrderLineItemTax type in the order field of CreateOrderRequest instead

Customer

Represents a Square customer profile which can have one or more cards on file associated with it

CustomerCreationSourceFilter

Creation source filter

CustomerFilter

Represents a set of CustomerQuery filters used to limit the set of Customers returned by SearchCustomers

CustomerGroupInfo

Contains some brief information about a customer group with its identifier included

CustomerPreferences

Represents communication preferences for the customer profile

CustomerQuery

Represents a query filtering and sorting criteria used to search for customer profiles

CustomerSort

Indicates the field to use for sorting customer profiles

DateRange

A range defined by two dates

Device

DeviceDetails

Details about the device that took the payment

Employee

An employee object that is used by the external API

EmployeeWage

The hourly wage rate that an employee will earn on a Shift for doing the job specified by the title property of this object

Error

Represents an error encountered during a request to the Connect API

ExternalPaymentDetails

Additional details about EXTERNAL type payments

InventoryAdjustment

Represents a change in state or quantity of product inventory at a particular time and location

InventoryChange

Represents a single physical count inventory adjustment or transfer that is part of the history of inventory changes for a particular CatalogObject

InventoryCount

Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments

InventoryCountUpdatedWebhook

InventoryCountUpdatedWebhookData

InventoryCountUpdatedWebhookObject

InventoryPhysicalCount

Represents the quantity of an item variation that is physically present at a specific location verified by a seller or a seller's employee

InventoryTransfer

Represents the transfer of a quantity of product inventory at a particular time from one location to another

ItemVariationLocationOverrides

Price and inventory alerting overrides for a CatalogItemVariation at a specific Location

LaborShiftCreatedWebhook

LaborShiftCreatedWebhookData

LaborShiftCreatedWebhookObject

LaborShiftDeletedWebhook

LaborShiftDeletedWebhookData

LaborShiftUpdatedWebhook

LaborShiftUpdatedWebhookData

LaborShiftUpdatedWebhookObject

Location

MeasurementUnit

Represents a unit of measurement to use with a quantity such as ounces or inches

MeasurementUnitCustom

The information needed to define a custom unit provided by the seller

Merchant

Represents a Square seller

Money

Represents an amount of money

Order

Contains all information related to a single order to process with Square including line items that specify the products to purchase

OrderEntry

A lightweight description of an Order that is returned when returned_entries is true on a SearchOrderRequest

OrderFulfillment

Contains details on how to fulfill this order

OrderFulfillmentPickupDetails

Contains details necessary to fulfill a pickup order

OrderFulfillmentRecipient

Contains information on the recipient of a fulfillment

OrderFulfillmentShipmentDetails

Contains details necessary to fulfill a shipment order

OrderLineItem

Represents a line item in an order

OrderLineItemAppliedDiscount

Represents an applied portion of a discount to a line item in an order

OrderLineItemAppliedTax

Represents an applied portion of a tax to a line item in an order

OrderLineItemDiscount

Represents a discount that applies to one or more line items in an order

OrderLineItemModifier

A CatalogModifier

OrderLineItemTax

Represents a tax that applies to one or more line item in the order

OrderMoneyAmounts

A collection of various money amounts

OrderQuantityUnit

Contains the measurement unit for a quantity and a precision which specifies the number of digits after the decimal point for decimal quantities

OrderReturn

The set of line items service charges taxes discounts tips etc

OrderReturnDiscount

Represents a discount being returned that applies to one or more return line items in an order

OrderReturnLineItem

The line item being returned in an Order

OrderReturnLineItemModifier

A line item modifier being returned

OrderReturnServiceCharge

Represents the service charge applied to the original order

OrderReturnTax

Represents a tax being returned that applies to one or more return line items in an order

OrderRoundingAdjustment

A rounding adjustment of the money being returned

OrderServiceCharge

Represents a service charge applied to an order

OrderSource

Represents the origination details of an order

Payment

Represents a payment processed by the Square API

PaymentRefund

Represents a refund of a payment made using Square

ProcessingFee

Represents Square processing fee

Refund

Represents a refund processed for a Square transaction

SearchOrdersCustomerFilter

Filter based on Order customer_id and any Tender customer_id associated with the Order

SearchOrdersDateTimeFilter

Filter for Order objects based on whether their CREATED_AT CLOSED_AT or UPDATED_AT timestamps fall within a specified time range

SearchOrdersFilter

Filtering criteria to use for a SearchOrders request

SearchOrdersFulfillmentFilter

Filter based on Order Fulfillment information

SearchOrdersQuery

Contains query criteria for the search

SearchOrdersSort

Sorting criteria for a SearchOrders request

SearchOrdersSourceFilter

Filter based on order source information

SearchOrdersStateFilter

Filter by current Order state

Shift

A record of the hourly rate start and end times for a single work shift for an employee

ShiftFilter

Defines a filter used in a search for Shift records

ShiftQuery

The parameters of a Shift search query

ShiftSort

Sets the sort order of search results

ShiftWage

The hourly wage rate used to compensate an employee for this shift

ShiftWorkday

A Shift search query filter parameter that sets a range of days that a Shift must start or end in before passing the filter condition

SourceApplication

Provides information about the application used to generate an inventory change

StandardUnitDescription

Contains the name and abbreviation for standard measurement unit

StandardUnitDescriptionGroup

Group of standard measurement units

Tender

Represents a tender ie a method of payment used in a Square transaction

TenderCardDetails

Represents additional details of a tender with type CARD or SQUARE_GIFT_CARD

TenderCashDetails

Represents the details of a tender with type CASH

TimeRange

Represents a generic time range

Transaction

Represents a transaction processed with Square either with the Connect API or with Square Point of Sale

Webhook

WebhookData

WorkweekConfig

Sets the Day of the week and hour of the day that a business starts a work week