Square API
Object IndexA
-
Address
Represents a physical address
-
AdditionalRecipientReceivableRefund
A refund of an AdditionalRecipientReceivable
-
AdditionalRecipientReceivable
Represents a monetary distribution of part of a Transaction's amount for Transactions which included additional recipients
-
AdditionalRecipient
Represents an additional recipient other than the merchant receiving a portion of this tender
B
-
BusinessHoursPeriod
Represents a period of time during which a business location is open
-
BusinessHours
Represents the hours of operation for a business location
-
BreakType
A defined break template that sets an expectation for possible Break instances on a Shift
-
Break
A record of an employee's break during a shift
-
BankAccountVerifiedWebhookObject
-
BankAccountVerifiedWebhookData
-
BankAccountDisabledWebhookObject
-
BankAccountDisabledWebhookData
-
BankAccountCreatedWebhookObject
-
BankAccountCreatedWebhookData
-
BankAccount
Represents a bank account
-
BankAccount
V1BankAccount
V1 -
BalancePaymentDetails
Reflects the current status of a balance payment
C
-
CustomerSort
Indicates the field to use for sorting customer profiles
-
CustomerQuery
Represents a query filtering and sorting criteria used to search for customer profiles
-
CustomerPreferences
Represents communication preferences for the customer profile
-
CustomerGroupInfo
Contains some brief information about a customer group with its identifier included
-
CustomerFilter
Represents a set of CustomerQuery filters used to limit the set of Customers returned by SearchCustomers
-
CustomerCreationSourceFilter
Creation source filter
-
Customer
Represents a Square customer profile which can have one or more cards on file associated with it
-
Coordinates
Latitude and longitude coordinates
-
Checkout
Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareupcom
-
ChargeRequestAdditionalRecipient
Represents an additional recipient other than the merchant entitled to a portion of the tender
-
Category
V1Category
V1 -
CatalogVersionUpdatedWebhookObject
-
CatalogVersionUpdatedWebhookData
-
CatalogVersionUpdatedWebhookCatalogVersion
-
CatalogV1Id
An Items Connect V1 object ID along with its associated location ID
-
CatalogTimePeriod
Represents a time period - either a single period or a repeating period
-
CatalogTax
A tax in the Catalog object model
-
CatalogQueryText
-
CatalogQuerySortedAttribute
-
CatalogQueryRange
-
CatalogQueryPrefix
-
CatalogQueryItemVariationsForItemOptionValues
-
CatalogQueryItemsForTax
-
CatalogQueryItemsForModifierList
-
CatalogQueryItemsForItemOptions
-
CatalogQueryFilteredItemsCustomAttributeFilter
-
CatalogQueryFilteredItems
-
CatalogQueryExact
-
CatalogQueryCustomAttributeUsage
-
CatalogQuery
A query to be applied to a SearchCatalogObjectsRequest
-
CatalogProductSet
Represents a collection of catalog objects for the purpose of applying a PricingRule
-
CatalogPricingRule
Defines how prices are modified or set for items that match the pricing rule during the active time period
-
CatalogObjectBatch
A batch of catalog objects
-
CatalogObject
The wrapper object for object types in the Catalog data model
-
CatalogModifierOverride
-
CatalogModifierList
A modifier list in the Catalog object model
-
CatalogModifier
A modifier in the Catalog object model
-
CatalogMeasurementUnit
Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities
-
CatalogItemVariation
An item variation ie product in the Catalog object model
-
CatalogItemOptionValueForItemVariation
A CatalogItemOptionValue links an item variation to an item option as an item option value
-
CatalogItemOptionValue
An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values
-
CatalogItemOptionForItem
A list of item option values that can be assigned to item variations
-
CatalogItemOption
A group of variations for a CatalogItem
-
CatalogItemModifierListInfo
Controls the properties of a CatalogModifierList as it applies to this CatalogItem
-
CatalogItem
An item ie product family in the Catalog object model
-
CatalogInfoResponseLimits
-
CatalogImage
An image file to use in Square catalogs
-
CatalogIdMapping
A mapping between a client-supplied temporary ID and a permanent server ID
-
CatalogDiscount
A discount in the Catalog object model
-
CatalogCustomAttributeValue
An instance of a custom attribute
-
CatalogCustomAttributeDefinitionStringConfig
Configuration associated with Custom Attribute Definitions of type STRING
-
CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
A named selection for this SELECTION-type custom attribute definition
-
CatalogCustomAttributeDefinitionSelectionConfig
Configuration associated with SELECTION-type custom attribute definitions
-
CatalogCustomAttributeDefinition
Contains information defining a custom attribute
-
CatalogCategory
A category to which a CatalogItem belongs in the Catalog object model
-
CashDrawerShiftSummary
The summary of a closed cash drawer shift
-
CashDrawerShiftEvent
-
CashDrawerShift
This model gives the details of a cash drawer shift
-
CashDrawerShift
Contains details for a single cash drawer shift
V1 -
CashDrawerEvent
V1CashDrawerEvent
V1 -
CashDrawerDevice
-
CardPaymentDetails
Reflects the current status of a card payment
-
Card
Represents the payment details of a card to be used for payments
D
-
DisputeStateChangedWebhookObject
-
DisputeStateChangedWebhookData
-
DisputeEvidenceRemovedWebhookObject
-
DisputeEvidenceRemovedWebhookData
-
DisputeEvidenceFile
A file to be uploaded as dispute evidence
-
DisputeEvidenceAddedWebhookObject
-
DisputeEvidenceAddedWebhookData
-
DisputeEvidence
-
DisputedPayment
The payment the cardholder disputed
-
DisputeCreatedWebhookObject
-
DisputeCreatedWebhookData
-
Dispute
Represents a dispute a cardholder initiated with their bank
-
Discount
V1Discount
V1 -
DeviceDetails
Details about the device that took the payment
-
Device
-
DateRange
A range defined by two dates
E
-
Error
Represents an error encountered during a request to the Connect 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
-
EmployeeRole
V1EmployeeRole
V1 -
Employee
An employee object that is used by the external API
-
Employee
Represents one of a business's employees
V1
I
-
ItemVariationLocationOverrides
Price and inventory alerting overrides for a CatalogItemVariation at a specific Location
-
ItemImage
V1ItemImage
V1 -
Item
V1Item
V1 -
InventoryTransfer
Represents the transfer of a quantity of product inventory at a particular time from one location to another
-
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
-
InventoryEntry
V1InventoryEntry
V1 -
InventoryCountUpdatedWebhookObject
-
InventoryCountUpdatedWebhookData
-
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
-
InventoryChange
Represents a single physical count inventory adjustment or transfer that is part of the history of inventory changes for a particular CatalogObject
-
InventoryAdjustment
Represents a change in state or quantity of product inventory at a particular time and location
M
-
Money
Represents an amount of money
-
Money
V1 -
ModifierOption
V1ModifierOption
V1 -
ModifierList
V1ModifierList
V1 -
MethodErrorCodes
-
MerchantLocationDetails
Additional information for a single-location account specified by its associated business account if it has one
V1 -
Merchant
Represents a Square seller
-
Merchant
Defines the fields that are included in the response body of a request to the RetrieveBusiness endpoint
V1 -
MeasurementUnitCustom
The information needed to define a custom unit provided by the seller
-
MeasurementUnit
Represents a unit of measurement to use with a quantity such as ounces or inches
O
-
OrderSource
Represents the origination details of an order
-
OrderServiceCharge
Represents a service charge applied to an order
-
OrderRoundingAdjustment
A rounding adjustment of the money being returned
-
OrderReturnTax
Represents a tax being returned that applies to one or more return line items in an order
-
OrderReturnServiceCharge
Represents the service charge applied to the original order
-
OrderReturnLineItemModifier
A line item modifier being returned
-
OrderReturnLineItem
The line item being returned in an Order
-
OrderReturnDiscount
Represents a discount being returned that applies to one or more return line items in an order
-
OrderReturn
The set of line items service charges taxes discounts tips etc
-
OrderQuantityUnit
Contains the measurement unit for a quantity and a precision which specifies the number of digits after the decimal point for decimal quantities
-
OrderMoneyAmounts
A collection of various money amounts
-
OrderLineItemTax
Represents a tax that applies to one or more line item in the order
-
OrderLineItemModifier
A CatalogModifier
-
OrderLineItemDiscount
Represents a discount that applies to one or more line items in an order
-
OrderLineItemAppliedTax
Represents an applied portion of a tax to a line item in an order
-
OrderLineItemAppliedDiscount
Represents an applied portion of a discount to a line item in an order
-
OrderLineItem
Represents a line item in an order
-
OrderFulfillmentShipmentDetails
Contains details necessary to fulfill a shipment order
-
OrderFulfillmentRecipient
Contains information on the recipient of a fulfillment
-
OrderFulfillmentPickupDetails
Contains details necessary to fulfill a pickup order
-
OrderFulfillment
Contains details on how to fulfill this order
-
OrderEntry
A lightweight description of an Order that is returned when returned_entries is true on a SearchOrderRequest
-
Order
Contains all information related to a single order to process with Square including line items that specify the products to purchase
P
-
ProcessingFee
Represents Square processing fee
-
PhoneNumber
Represents a phone number
V1 -
PaymentUpdatedWebhookObject
-
PaymentUpdatedWebhookData
-
PaymentTax
V1PaymentTax
V1 -
PaymentSurcharge
V1PaymentSurcharge
V1 -
PaymentRefund
Represents a refund of a payment made using Square
-
PaymentModifier
V1PaymentModifier
V1 -
PaymentItemization
Payment include an itemizations field that lists the items purchased along with associated fees modifiers and discounts
V1 -
PaymentItemDetail
V1PaymentItemDetail
V1 -
PaymentDiscount
V1PaymentDiscount
V1 -
PaymentCreatedWebhookObject
-
PaymentCreatedWebhookData
-
Payment
Represents a payment processed by the Square API
-
Payment
A payment represents a paid transaction between a Square merchant and a customer
V1 -
PageCell
V1PageCell
V1 -
Page
V1Page
V1
S
-
StandardUnitDescriptionGroup
Group of standard measurement units
-
StandardUnitDescription
Contains the name and abbreviation for standard measurement unit
-
SourceApplication
Provides information about the application used to generate an inventory change
-
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
-
ShiftWage
The hourly wage rate used to compensate an employee for this shift
-
ShiftSort
Sets the sort order of search results
-
ShiftQuery
The parameters of a Shift search query
-
ShiftFilter
Defines a filter used in a search for Shift records
-
Shift
A record of the hourly rate start and end times for a single work shift for an employee
-
SettlementEntry
V1SettlementEntry
V1 -
Settlement
V1Settlement
V1 -
SearchOrdersStateFilter
Filter by current Order state
-
SearchOrdersSourceFilter
Filter based on order source information
-
SearchOrdersSort
Sorting criteria for a SearchOrders request
-
SearchOrdersQuery
Contains query criteria for the search
-
SearchOrdersFulfillmentFilter
Filter based on Order Fulfillment information
-
SearchOrdersFilter
Filtering criteria to use for a SearchOrders request
-
SearchOrdersDateTimeFilter
Filter for Order objects based on whether their CREATED_AT CLOSED_AT or UPDATED_AT timestamps fall within a specified time range
-
SearchOrdersCustomerFilter
Filter based on Order customer_id and any Tender customer_id associated with the Order
T
-
Transaction
Represents a transaction processed with Square either with the Connect API or with Square Point of Sale
-
TimeRange
Represents a generic time range
-
TimecardEvent
V1TimecardEvent
V1 -
Timecard
Represents a timecard for an employee
V1 -
TenderCashDetails
Represents the details of a tender with type CASH
-
TenderCardDetails
Represents additional details of a tender with type CARD or SQUARE_GIFT_CARD
-
Tender
Represents a tender ie a method of payment used in a Square transaction
-
Tender
A tender represents a discrete monetary exchange
V1