Module square_api_client::models
source · [−]Expand description
Model structs
Modules
Structs
ACH-specific details about
BANK_ACCOUNT type payments with the transfer_type of ACH.AdditionalRecipientDeprecated
Represents an additional recipient (other than the merchant) receiving a portion of this tender.
Represents a postal address in a country.
Additional details about Afterpay payments.
Details about the application that took the payment.
Additional details about BANK_ACCOUNT type payments.
This is a model class for BatchChangeInventoryRequest type.
This is a model struct for BatchChangeInventoryResponse type.
This is a model class for BatchDeleteCatalogObjectsRequest type.
This is a model struct for BatchDeleteCatalogObjectsResponse type.
This is a model class for BatchRetrieveCatalogObjectsRequest type.
This is a model struct for BatchRetrieveCatalogObjectsResponse type.
This is a model struct for BatchRetrieveInventoryChangesRequest type.
This is a model struct for BatchRetrieveInventoryChangesResponse type.
This is a model struct for BatchRetrieveInventoryCountsRequest type.
This is a model struct for BatchRetrieveInventoryCountsResponse type.
This is a model class for BatchRetrieveOrdersRequest type.
This is a model struct for BatchRetrieveOrdersResponse type.
This is a model class for BatchUpsertCatalogObjectsRequest type.
This is a model struct for BatchUpsertCatalogObjectsResponse type.
The hours of operation for a location.
The hours of operation for a location.
Additional details about a Buy Now Pay Later payment type.
This is a model struct for CalculateOrderRequest type
This is a model struct for CalculateOrderResponse type.
This is a model struct for CancelPaymentByIdempotencyRequest type.
This is a model struct for CancelPaymentByIdempotencyKeyResponse type.
This is a model struct for CancelPaymentResponse type.
Represents the payment details of a card to be used for payments.
Reflects the current status of a card payment.
The timeline for card payments.
Stores details about a cash payment.
A category to which a
CatalogItem instance belongs.Contains information defining a custom attribute.
Configuration associated with Custom Attribute Definitions of type
NUMBER.Configuration associated with
SELECTION-type custom attribute definitions.A named selection for this
SELECTION-type custom attribute definition.Configuration associated with Custom Attribute Definitions of type
STRING.An instance of a custom attribute.
A discount applicable to items.
A mapping between a temporary client-supplied ID and a permanent server-generated ID.
An image file to use in Square catalogs.
This is a model struct for CatalogInfoResponse type.
Limits that apply to the Catalog Info API.
A CatalogObject instance of the
ITEM type, also referred to as an item, in the catalog.Options to control the properties of a
CatalogModifierList applied to a CatalogItem
instance.A group of variations for a
CatalogItem.An option that can be assigned to an item.
An enumerated value that can link a
CatalogItemVariation to an item option as one of its item
option values.A
CatalogItemOptionValue links an item variation to an item option as an item option value.An item variation (i.e., product) in the Catalog object model.
Represents the unit used to measure a
CatalogItemVariation and specifies the precision for
decimal quantities.A modifier applicable to items at the time of sale.
list of modifiers applicable to items at the time of sale.
Options to control how to override the default behavior of the specified modifier.
The wrapper object for the catalog entries of a given object type.
A batch of catalog objects
Defines how discounts are automatically applied to a set of items that match the pricing rule
during the active time period.
Represents a collection of catalog objects for the purpose of applying a
PricingRule.A query composed of one or more different types of filters to narrow the scope of targeted
objects when calling the
SearchCatalogObjects endpoint.The query filter to return the search result by exact match of the specified attribute name and
value.
The query filter to return the item variations containing the specified item option value IDs.
The query filter to return the items containing the specified item option IDs.
The query filter to return the items containing the specified modifier list IDs.
The query filter to return the items containing the specified tax IDs.
The query filter to return the search result whose named attribute values are prefixed by the
specified attribute value.
The query filter to return the search result whose named attribute values fall between the
specified range.
The query filter to return the search result(s) by exact match of the specified
attribute_name
and any of the attribute_values.The query expression to specify the key to sort search results.
The query filter to return the search result whose searchable attribute values contain all of
the specified keywords or tokens, independent of the token order or case.
Represents a Quick Amount in the Catalog.
A parent Catalog Object model represents a set of Quick Amounts and the settings control the
amounts.
Represents the rule of conversion between a stockable [CatalogItemVariation] and a non-stockable
sell-by or receive-by
CatalogItemVariation that share the same underlying stock.Describes a subscription plan.
A tax applicable to an item.
Represents a time period - either a single period or a repeating period.
A Square API V1 identifier of an item, including the object ID and its associated location ID.
This is a model struct for CloneOrderRequest type.
This is a model struct for CloneOrderResponse type.
This is a model struct for CompletePaymentRequest type.
This is a model struct for CompletePaymentResponse type.
Latitude and longitude coordinates.
This is a model class for CreateCardRequest type.
This is a model struct for CreateCardResponse type.
This is a model class for CreateCatalogImageRequest type.
This is a model struct for CreateCatalogImageResponse type.
This is a model struct for CreateGiftCardActivityRequest type
This is a model struct for CreateGiftCardActivityResponse type
This is a model struct for CreateGiftCardRequest type
This is a model struct for CreateGiftCardResponse type
This is a model struct for CreateLocationRequest type
This is a model struct for CreateLocationResponse type
This is a model struct for CreateOrderRequest type
This is a model struct for CreateOrderResponse type
This is a model class for CreatePaymentRequest type.
This is a model struct for CreatePaymentResponse type.
Represents a Square customer profile in the Customer Directory of a Square seller.
Represents communication preferences for the customer profile.
Represents the tax ID associated with a [Customer] profile.
Represents a Timestamp or DateTime.
This is a model struct for DeleteCatalogObjectResponse type
This is a model struct for DeleteCustomerResponse type
Details about the device that took the payment.
Additional details about
WALLET type payments.This is a model struct for DisableCardResponse type
Stores details about an external payment.
This is a model struct for GetPaymentRefundResponse type
This is a model struct for GetPaymentResponse type.
Represents a Square gift card.
Represents an action performed on a gift card that affects its state or balance.
Represents details about an
ACTIVATE gift card activity type.Represents details about an
ADJUST_DECREMENT gift card activity type.Represents details about an
ADJUST_INCREMENT gift card activity type.Represents details about a
BLOCK gift card activity type.Represents details about a
CLEAR_BALANCE gift card activity type.Represents details about a
DEACTIVATE gift card activity type.Represents details about an
IMPORT gift card activity type.Represents details about an
IMPORT_REVERSAL gift card activity type.Represents details about a
LOAD gift card activity type.Represents details about a
REDEEM gift card activity type.Represents details about a
REFUND gift card activity type.Represents details about a
UNBLOCK gift card activity type.Represents details about a
UNLINKED_ACTIVITY_REFUND
gift card activity type.Represents a change in state or quantity of product inventory at a particular time and location.
The current calculated inventory counts for the requested object and locations.
Changes created for the request.
The current calculated inventory counts for the requested object and locations.
Represents the quantity of an item variation that is physically present at a specific location,
verified by a seller or a seller’s employee.
Represents the transfer of a quantity of product inventory at a particular time from one location to another.
Price and inventory alerting overrides for a
CatalogItemVariation at a specific Location.This is a model struct for LinkCustomerToGiftCardRequest type
This is a model struct for LinkCustomerToGiftCardResponse type
This is a model struct for ListCardsParameters (query parameters)
This is a model struct for ListCardsResponse type
This is a model struct for ListCatalogParameters (query parameters)
This is a model struct for ListCatalogResponse type
This is a model struct for ListCustomersParameters (query parameters)
This is a model struct for ListCustomersResponse type
This is a model struct for ListGiftCardActivitiesParameters (query parameters)
This is a model struct for ListGiftCardActivitiesResponse type
This is a model struct for ListGiftCardsParameters (query parameters)
This is a model struct for ListGiftCardsResponse type
This is a model struct for ListLocationsResponse type
This is a model struct for ListPaymentRefundsParameters (query parameters)
This is a model struct for ListPaymentRefundsResponse type
This is a model struct for ListPaymentsParameters (query parameters)
This is a model struct for ListPaymentsResponse type
Represents a unit of measurement to use with a quantity, such as ounces or inches.
The information needed to define a custom unit, provided by the seller.
Represents an amount of money.
Contains all information related to a single order to process with Square, including line items
that specify the products to purchase.
A lightweight description of an order that is returned when
returned_entries is
true on a [SearchOrdersRequest].This is a model struct for OrderFulfillment type.
This is a model struct for OrderFulfillmentFulfillmentEntry type.
This is a model struct for OrderFulfillmentPickupDetails type.
Specific details for curbside pickup.
Contains information about the recipient of a fulfillment.
Contains the details necessary to fulfill a shipment order.
Represents a line item in an order.
Represents an applied portion of a discount to a line item in an order.
Represents an applied portion of a tax to a line item in an order.
Represents a discount that applies to one or more line items in an order.
A [CatalogModifier].
Describes pricing adjustments that are blocked from manual and automatic application to a line
item.
A discount to block from applying to a line item.
A tax to block from applying to a line item.
Represents a tax that applies to one or more line item in the order.
A collection of various money amounts.
Pricing options for an order.
Contains the measurement unit for a quantity and a precision that specifies the number of digits
after the decimal point for decimal quantities.
The set of line items, service charges, taxes, discounts, tips, and other items being returned
in an order.
Represents a discount being returned that applies to one or more return line items in an order.
The line item being returned in an order.
A line item modifier being returned.
Represents the service charge applied to the original order.
Represents a tax being returned that applies to one or more return line items in an order.
Represents a reward that can be applied to an order if the necessary reward tier criteria are met.
A rounding adjustment of the money being returned.
Represents a service charge applied to an order.
Represents the origination details of an order.
This is a model struct for PayOrderRequest type
This is a model struct for PayOrderResponse type
Represents a payment processed by the Square API.
Represents a refund of a payment made using Square.
Represents the Square processing fee.
Represents a refund processed for a Square transaction.
This is a model struct for RefundPaymentRequest type
This is a model struct for RefundPaymentResponse type
This is a model struct for RetrieveCardResponse type
This is a model struct for RetrieveCatalogObjectParameters (query parameters)
This is a model struct for RetrieveCatalogObjectResponse type
This is a model struct for RetrieveCardResponse type
This is a model struct for RetrieveGiftCardFromGANRequest type
This is a model struct for RetrieveGiftCardFromGANResponse type
This is a model struct for RetrieveGiftCardFromNonceRequest type
This is a model struct for RetrieveGiftCardFromNonceResponse type
This is a model struct for RetrieveGiftCardResponse type
This is a model struct for RetrieveInventoryAdjustmentResponse type.
This is a model struct for RetrieveInventoryCountResponse type.
This is a model struct for RetrieveInventoryPhysicalCount type.
This is a model struct for RetrieveInventoryTransferResponse type.
This is a model struct for RetrieveLocationResponse type
This is a model struct for RetrieveOrderResponse type.
Represents fraud risk information for the associated payment.
This is a model struct for SearchCatalogItemsRequest type.
This is a model struct for SearchCatalogItemsResponse type
This is a model struct for SearchCatalogObjectsRequest type.
This is a model struct for SearchCatalogObjectsResponse type
Filter based on order fulfillment information
Filter for
Customer objects based on whether their CREATED_AT
timestamps fall within a specified time range.Filtering criteria to use for a
SearchCustomers request.Contains query criteria for the search.
This is a model struct for SearchCustomersRequest type.
This is a model struct for SearchCustomersResponse type
Sorting criteria for a
SearchCustomers request.A filter based on the order
customer_id and any tender customer_id associated with the
order.Filter for
Order objects based on whether their CREATED_AT, CLOSED_AT, or UPDATED_AT
timestamps fall within a specified time range.Filtering criteria to use for a
SearchOrders request.Filter based on order fulfillment information
Contains query criteria for the search.
This is a model struct for SearchOrdersRequest type.
This is a model struct for SearchOrdersResponse type
Sorting criteria for a
SearchOrders request.A filter based on order
source information.Filter by the current order
state.Provides information about the application used to generate a change.
Contains the name and abbreviation for standard measurement unit.
Group of standard measurement units.
Describes a phase in a subscription plan.
Identifiers for the location used by various governments for tax purposes.
Represents a tender (i.e., a method of payment) used in a Square transaction.
Represents additional details of a tender with type
CARD or SQUARE_GIFT_CARDRepresents the details of a tender with
type CASH.Represents a generic time range.
TransactionDeprecated
Represents a transaction processed with Square, either with the Connect API or with Square Point
of Sale.
This is a model struct for UnlinkCustomerFromGiftCardRequest type
This is a model struct for UnlinkCustomerFromGiftCardResponse type
This is a model struct for UpdateCatalogImageRequest type.
This is a model struct for UpdateCatalogImageResponse type.
This is a model struct for UpdateOrderRequest type.
This is a model struct for UpdateCustomerResponse type.
This is a model struct for UpdateItemModifierListsRequest type.
This is a model struct for UpdateItemModifierListsResponse type.
This is a model struct for UpdateItemTaxesRequest type.
This is a model struct for UpdateItemTaxesResponse type.
This is a model struct for the UpdateLocationRequest type
This is a model struct for UpdateLocationResponse type
This is a model struct for UpdateOrderRequest type.
This is a model struct for UpdateOrderResponse type.
This is a model struct for UpdatePaymentRequest type.
This is a model struct for UpdatePaymentResponse type.
This is a model struct for UpsertCatalogObjectRequest type.
This is a model struct for UpsertCatalogObjectResponse type.