Square Orders API
The Orders API from Square — 7 operation(s) for orders.
Square Orders API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 8 operations across 7 paths, and defines 111 schemas. It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
8 operations
7 paths
111 schemas
1 GET6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Square Orders API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes.
An API key is passed in the header as Authorization (oauth2ClientSecret).
Paths & Operations 8
Across 7 paths, the API surfaces 8 operations — 1 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Orders 8
POST
/v2/orders
Square Create Order
POST
/v2/orders/batch-retrieve
Square Batch Retrieve Orders
POST
/v2/orders/calculate
Square Calculate Order
POST
/v2/orders/clone
Square Clone Order
POST
/v2/orders/search
Square Search Orders
GET
/v2/orders/{order_id}
Square Retrieve Order
PUT
/v2/orders/{order_id}
Square Update Order
POST
/v2/orders/{order_id}/pay
Square Pay Order
Schemas 111
The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are Order (31 properties), FulfillmentDeliveryDetails (23 properties), OrderLineItem (22 properties), OrderReturnLineItem (21 properties). Each schema is shown below with its type and property counts.
Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
SearchOrdersStateFilter
object
Filter by the current order state.
1 property
1 required
OrderReturnTip
object
A tip being returned.
4 properties
PayOrderResponse
object
Defines the fields that are included in the response body of a request to the [PayOrder](api-endpoint:Orders-PayOrder) endpoint.
2 properties
RetrieveOrderResponse
object
2 properties
FulfillmentPickupDetailsCurbsidePickupDetails
object
Specific details for curbside pickup.
2 properties
OrderReturnDiscount
object
Represents a discount being returned that applies to one or more return line items in an order. Fixed-amount, order-scoped discounts are distributed across all…
10 properties
OrderLineItemPricingBlocklists
object
Describes pricing adjustments that are blocked from automatic application to a line item. For more information, see [Apply Taxes and Discounts](https://develop…
2 properties
RefundStatus
string
Indicates a refund's current status.
FulfillmentFulfillmentLineItemApplication
string
The lineitemapplication describes what order line items this fulfillment applies to. It can be ALL or ENTRYLIST with a supplied list of fulfillment entries.
OrderRoundingAdjustment
object
A rounding adjustment of the money being returned. Commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physica…
3 properties
SearchOrdersSort
object
Sorting criteria for a SearchOrders request. Results can only be sorted by a timestamp field.
2 properties
1 required
OrderReturnTax
object
Represents a tax being returned that applies to one or more return line items in an order. Fixed-amount, order-scoped taxes are distributed across all non-zero…
9 properties
BatchRetrieveOrdersResponse
object
Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.
2 properties
MeasurementUnitCustom
object
The information needed to define a custom unit, provided by the seller.
2 properties
2 required
OrderReturnLineItemModifier
object
A line item modifier being returned.
8 properties
OrderLineItemDiscount
object
Represents a discount that applies to one or more line items in an order. Fixed-amount, order-scoped discounts are distributed across all non-zero line item to…
12 properties
OrderLineItemItemType
string
Represents the line item type.
UpdateOrderResponse
object
Defines the fields that are included in the response body of a request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.
2 properties
TenderBankAccountDetailsStatus
string
Indicates the bank account payment's current status.
OrderLineItemPricingBlocklistsBlockedDiscount
object
A discount to block from applying to a line item. The discount must be identified by either discountuid or discountcatalogobjectid, but not both.
3 properties
OrderLineItemAppliedServiceCharge
object
3 properties
1 required
FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType
string
The schedule type of the delivery fulfillment.
MeasurementUnitVolume
string
The unit of volume used to measure a quantity.
OrderMoneyAmounts
object
A collection of various money amounts.
5 properties
OrderReward
object
Represents a reward that can be applied to an order if the necessary reward tier criteria are met. Rewards are created through the Loyalty API.
2 properties
2 required
FulfillmentFulfillmentEntry
object
Links an order line item to a fulfillment. Each entry must reference a valid uid for an order line item in the lineitemuid field, as well as a quantity to fulf…
4 properties
2 required
Card
object
Represents the payment details of a card to be used for payments. These details are determined by the payment token generated by Web Payments SDK.
17 properties
CreateOrderResponse
object
Defines the fields that are included in the response body of a request to the CreateOrder endpoint. Either errors or order is present in a given response, but…
2 properties
MeasurementUnitLength
string
The unit of length used to measure a quantity.
MeasurementUnitUnitType
string
Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
CardBrand
string
Indicates a card's brand, such as VISA or MASTERCARD.
OrderReturnServiceCharge
object
Represents the service charge applied to the original order.
15 properties
SearchOrdersCustomerFilter
object
A filter based on the order customerid and any tender customerid associated with the order. It does not filter based on the [FulfillmentRecipient](entity:Fulfi…
1 property
OrderPricingOptions
object
Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that…
2 properties
MeasurementUnitWeight
string
Unit of weight used to measure a quantity.
TenderCashDetails
object
Represents the details of a tender with type CASH.
2 properties
OrderLineItemAppliedTax
object
Represents an applied portion of a tax to a line item in an order. Order-scoped taxes automatically include the applied taxes in each line item. Line item taxe…
3 properties
1 required
CreateOrderRequest
object
2 properties
TenderCardDetails
object
Represents additional details of a tender with type CARD or SQUAREGIFTCARD
3 properties
Tender
object
Represents a tender (i.e., a method of payment) used in a Square transaction.
17 properties
1 required
Address
object
Represents a postal address in a country. For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addr…
14 properties
FulfillmentState
string
The current state of this fulfillment.
OrderLineItemAppliedDiscount
object
Represents an applied portion of a discount to a line item in an order. Order scoped discounts have automatically applied discounts present for each line item.…
3 properties
1 required
TenderSquareAccountDetailsStatus
string
FulfillmentPickupDetailsScheduleType
string
The schedule type of the pickup fulfillment.
OrderServiceChargeType
string
SearchOrdersSortField
string
Specifies which timestamp to use to sort SearchOrder results.
SearchOrdersRequest
object
5 properties
OrderServiceChargeTreatmentType
string
Indicates whether the service charge will be treated as a value-holding line item or apportioned toward a line item.
MeasurementUnitArea
string
Unit of area used to measure a quantity.
Order
object
Contains all information related to a single order to process with Square, including line items that specify the products to purchase. Order objects also inclu…
31 properties
1 required
Fulfillment
object
Contains details about how to fulfill this order. Orders can only be created with at most one fulfillment using the API. However, orders returned by the Orders…
9 properties
FulfillmentShipmentDetails
object
Contains the details necessary to fulfill a shipment order.
15 properties
CloneOrderRequest
object
Defines the fields that are included in requests to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.
3 properties
1 required
TenderType
string
Indicates a tender's type.
OrderLineItemTaxType
string
Indicates how the tax is applied to the associated line item or order.
OrderLineItemModifier
object
A [CatalogModifier](entity:CatalogModifier).
8 properties
OrderReturnLineItem
object
The line item being returned in an order.
21 properties
1 required
SearchOrdersFulfillmentFilter
object
Filter based on [order fulfillment](entity:Fulfillment) information.
2 properties
SearchOrdersDateTimeFilter
object
Filter for Order objects based on whether their CREATEDAT, CLOSEDAT, or UPDATEDAT timestamps fall within a specified time range. You can specify the time range…
3 properties
SearchOrdersFilter
object
Filtering criteria to use for a SearchOrders request. Multiple filters are ANDed together.
5 properties
TenderBuyNowPayLaterDetailsBrand
string
TenderSquareAccountDetails
object
Represents the details of a tender with type SQUAREACCOUNT.
1 property
CloneOrderResponse
object
Defines the fields that are included in the response body of a request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.
2 properties
AdditionalRecipient
object
Represents an additional recipient (other than the merchant) receiving a portion of this tender.
4 properties
2 required
FulfillmentRecipient
object
Information about the fulfillment recipient.
5 properties
OrderEntry
object
A lightweight description of an [order](entity:Order) that is returned when returnedentries is true on a [SearchOrdersRequest](api-endpoint:Orders-SearchOrders…
3 properties
SearchOrdersResponse
object
Either the orderentries or orders field is set, depending on whether returnentries is set on the [SearchOrdersRequest](api-endpoint:Orders-SearchOrders).
4 properties
Country
string
Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/count…
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
OrderServiceChargeScope
string
Indicates whether this is a line-item or order-level apportioned service charge.
OrderLineItemTaxScope
string
Indicates whether this is a line-item or order-level tax.
SearchOrdersSourceFilter
object
A filter based on order source information.
1 property
MeasurementUnitGeneric
string
BatchRetrieveOrdersRequest
object
Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
2 properties
1 required
OrderLineItemDiscountScope
string
Indicates whether this is a line-item or order-level discount.
Refund
object
Represents a refund processed for a Square transaction.
10 properties
6 required
TenderBuyNowPayLaterDetailsStatus
string
CardCoBrand
string
Indicates the brand for a co-branded card.
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
SearchOrdersQuery
object
Contains query criteria for the search.
2 properties
CalculateOrderRequest
object
2 properties
1 required
OrderLineItemDiscountType
string
Indicates how the discount is applied to the associated line item or order.
TenderBankAccountDetails
object
Represents the details of a tender with type BANKACCOUNT. See [BankAccountPaymentDetails](entity:BankAccountPaymentDetails) for more exposed details of a bank…
1 property
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
OrderLineItemPricingBlocklistsBlockedTax
object
A tax to block from applying to a line item. The tax must be identified by either taxuid or taxcatalogobjectid, but not both.
3 properties
CardType
string
Indicates a card's type, such as CREDIT or DEBIT.
TenderCardDetailsStatus
string
Indicates the card transaction's current status.
OrderQuantityUnit
object
Contains the measurement unit for a quantity and a precision that specifies the number of digits after the decimal point for decimal quantities.
4 properties
CardPrepaidType
string
Indicates a card's prepaid type, such as NOTPREPAID or PREPAID.
TenderBuyNowPayLaterDetails
object
Represents the details of a tender with type BUYNOWPAYLATER.
2 properties
OrderServiceChargeCalculationPhase
string
Represents a phase in the process of calculating order totals. Service charges are applied after the indicated phase. [Read more about how order totals are cal…
OrderState
string
The state of the order.
OrderLineItem
object
Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
22 properties
1 required
TimeRange
object
Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on…
2 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
CalculateOrderResponse
object
2 properties
TenderCardDetailsEntryMethod
string
Indicates the method used to enter the card's details.
OrderLineItemTax
object
Represents a tax that applies to one or more line item in the order. Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The…
10 properties
OrderReturn
object
The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.
9 properties
MeasurementUnit
object
Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: customunit, areaunit, leng…
8 properties
MeasurementUnitTime
string
Unit of time used to measure a quantity (a duration).
OrderSource
object
Represents the origination details of an order.
1 property
UpdateOrderRequest
object
Defines the fields that are included in requests to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.
3 properties
FulfillmentPickupDetails
object
Contains details necessary to fulfill a pickup order.
18 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties
2 required
FulfillmentDeliveryDetails
object
Describes delivery details of an order fulfillment.
23 properties
FulfillmentType
string
The type of fulfillment.
OrderServiceCharge
object
Represents a service charge applied to an order.
16 properties
PayOrderRequest
object
Defines the fields that are included in requests to the [PayOrder](api-endpoint:Orders-PayOrder) endpoint.
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Square 12
Other APIs Square publishes across the network.
Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
#Order
Where this information came from
This is an independent, third-party profile of Square Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.