API Explorer

You are viewing an old version of the API

All Versions

Calculate order

Beta

- POST /v2/orders/calculate

Enables applications to preview order pricing without creating an order.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

order

The order to be calculated. Expects the entire order, not a sparse update.

Order

location_id

The ID of the seller location that this order is associated with.

Min Length 1

string

customer_id

The ID of the customer associated with the order.

You should specify a customer_id on the order (or the payment) to ensure that transactions are reliably linked to customers. Omitting this field might result in the creation of new instant profiles.

Max Length 191

string

discounts

The list of all discounts associated with the order.

Discounts can be scoped to either ORDER or LINE_ITEM. For discounts scoped to LINE_ITEM, an OrderLineItemAppliedDiscount must be added to each line item that the discount applies to. For discounts with ORDER scope, the server generates an OrderLineItemAppliedDiscount for every line item.

IMPORTANT: If LINE_ITEM scope is set on any discounts in this field, using the deprecated line_items.discounts field results in an error. Use line_items.applied_discounts instead.

OrderLineItemDiscount [ ]

fulfillments

Details about order fulfillment.

Orders can only be created with at most one fulfillment. However, orders returned by the API might contain multiple fulfillments.

Fulfillment [ ]

line_items[0] OrderLineItem [ ]

quantity

The quantity purchased, formatted as a decimal number. For example, "3".

Line items with a quantity of "0" are automatically removed when paying for or otherwise completing the order.

Line items with a quantity_unit can have non-integer quantities. For example, "1.70000".

Min Length 1 Max Length 12

string

applied_discounts

The list of references to discounts applied to this line item. Each OrderLineItemAppliedDiscount has a discount_uid that references the uid of a top-level OrderLineItemDiscounts applied to the line item. On reads, the amount applied is populated.

An OrderLineItemAppliedDiscount is automatically created on every line item for all ORDER scoped discounts that are added to the order. OrderLineItemAppliedDiscount records for LINE_ITEM scoped discounts must be added in requests for the discount to apply to any line items.

To change the amount of a discount, modify the referenced top-level discount.

OrderLineItemAppliedDiscount [ ]

applied_service_charges

The list of references to service charges applied to this line item. Each OrderLineItemAppliedServiceCharge has a service_charge_id that references the uid of a top-level OrderServiceCharge applied to the line item. On reads, the amount applied is populated.

To change the amount of a service charge, modify the referenced top-level service charge.

OrderLineItemAppliedServiceCharge [ ]

applied_taxes

The list of references to taxes applied to this line item. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderLineItemTax applied to the line item. On reads, the amount applied is populated.

An OrderLineItemAppliedTax is automatically created on every line item for all ORDER scoped taxes added to the order. OrderLineItemAppliedTax records for LINE_ITEM scoped taxes must be added in requests for the tax to apply to any line items.

To change the amount of a tax, modify the referenced top-level tax.

OrderLineItemAppliedTax [ ]

base_price_money

The base price for a single unit of the line item.

Money

amount

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.

integer

currency

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

string

Select currency

USD United States dollar

catalog_object_id

The CatalogItemVariation ID applied to this line item.

Max Length 192

string

catalog_version

The version of the catalog object that this line item references.

integer

item_type

The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card.

string

Select item_type

ITEM Indicates that the line item is an itemized sale.
CUSTOM_AMOUNT Indicates that the line item is a non-itemized sale.
GIFT_CARD Indicates that the line item is a gift card sale. Gift cards sold through the Orders API are sold in an unactivated state and can be activated through the Gift Cards API using the line item uid.

metadata

Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

modifiers

The CatalogModifiers applied to this line item.

OrderLineItemModifier [ ]

name

The name of the line item.

Max Length 512

string

note

The note of the line item.

Max Length 2000

string

pricing_blocklists

Describes pricing adjustments that are blocked from automatic application to a line item. For more information, see Apply Taxes and Discounts.

OrderLineItemPricingBlocklists

quantity_unit

The unit and precision that this line item's quantity is measured in.

OrderQuantityUnit

uid

A unique ID that identifies the line item only within this order.

Max Length 60

string

variation_name

The name of the variation applied to this line item.

Max Length 400

string

line_items[1] OrderLineItem [ ]

quantity

The quantity purchased, formatted as a decimal number. For example, "3".

Line items with a quantity of "0" are automatically removed when paying for or otherwise completing the order.

Line items with a quantity_unit can have non-integer quantities. For example, "1.70000".

Min Length 1 Max Length 12

string

applied_discounts

To change the amount of a discount, modify the referenced top-level discount.

OrderLineItemAppliedDiscount [ ]

applied_service_charges

To change the amount of a service charge, modify the referenced top-level service charge.

OrderLineItemAppliedServiceCharge [ ]

applied_taxes

To change the amount of a tax, modify the referenced top-level tax.

OrderLineItemAppliedTax [ ]

base_price_money

The base price for a single unit of the line item.

Money

amount

integer

currency

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

string

Select currency

USD United States dollar

catalog_object_id

The CatalogItemVariation ID applied to this line item.

Max Length 192

string

catalog_version

The version of the catalog object that this line item references.

integer

item_type

The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card.

string

Select item_type

ITEM Indicates that the line item is an itemized sale.
CUSTOM_AMOUNT Indicates that the line item is a non-itemized sale.
GIFT_CARD Indicates that the line item is a gift card sale. Gift cards sold through the Orders API are sold in an unactivated state and can be activated through the Gift Cards API using the line item uid.

metadata

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

modifiers

The CatalogModifiers applied to this line item.

OrderLineItemModifier [ ]

name

The name of the line item.

Max Length 512

string

note

The note of the line item.

Max Length 2000

string

pricing_blocklists

Describes pricing adjustments that are blocked from automatic application to a line item. For more information, see Apply Taxes and Discounts.

OrderLineItemPricingBlocklists

quantity_unit

The unit and precision that this line item's quantity is measured in.

OrderQuantityUnit

uid

A unique ID that identifies the line item only within this order.

Max Length 60

string

variation_name

The name of the variation applied to this line item.

Max Length 400

string

line_items[2] OrderLineItem [ ]

quantity

The quantity purchased, formatted as a decimal number. For example, "3".

Line items with a quantity of "0" are automatically removed when paying for or otherwise completing the order.

Line items with a quantity_unit can have non-integer quantities. For example, "1.70000".

Min Length 1 Max Length 12

string

applied_discounts

To change the amount of a discount, modify the referenced top-level discount.

OrderLineItemAppliedDiscount [ ]

applied_service_charges

To change the amount of a service charge, modify the referenced top-level service charge.

OrderLineItemAppliedServiceCharge [ ]

applied_taxes

To change the amount of a tax, modify the referenced top-level tax.

OrderLineItemAppliedTax [ ]

base_price_money

The base price for a single unit of the line item.

Money

amount

integer

currency

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

string

Select currency

USD United States dollar

catalog_object_id

The CatalogItemVariation ID applied to this line item.

Max Length 192

string

catalog_version

The version of the catalog object that this line item references.

integer

item_type

The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card.

string

Select item_type

ITEM Indicates that the line item is an itemized sale.
CUSTOM_AMOUNT Indicates that the line item is a non-itemized sale.
GIFT_CARD Indicates that the line item is a gift card sale. Gift cards sold through the Orders API are sold in an unactivated state and can be activated through the Gift Cards API using the line item uid.

metadata

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

modifiers

The CatalogModifiers applied to this line item.

OrderLineItemModifier [ ]

name

The name of the line item.

Max Length 512

string

note

The note of the line item.

Max Length 2000

string

pricing_blocklists

Describes pricing adjustments that are blocked from automatic application to a line item. For more information, see Apply Taxes and Discounts.

OrderLineItemPricingBlocklists

quantity_unit

The unit and precision that this line item's quantity is measured in.

OrderQuantityUnit

uid

A unique ID that identifies the line item only within this order.

Max Length 60

string

variation_name

The name of the variation applied to this line item.

Max Length 400

string

metadata

Application-defined data attached to this order. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

pricing_options

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 are based on preconfigured pricing rules.

OrderPricingOptions

reference_id

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

Max Length 40

string

service_charges[0] OrderServiceCharge [ ]

amount_money

The amount of a non-percentage-based service charge.

Exactly one of percentage or amount_money should be set.

Money

applied_taxes

The list of references to the taxes applied to this service charge. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderLineItemTax that is being applied to this service charge. On reads, the amount applied is populated.

An OrderLineItemAppliedTax is automatically created on every taxable service charge for all ORDER scoped taxes that are added to the order. OrderLineItemAppliedTax records for LINE_ITEM scoped taxes must be added in requests for the tax to apply to any taxable service charge. Taxable service charges have the taxable field set to true and calculated in the SUBTOTAL_PHASE.

To change the amount of a tax, modify the referenced top-level tax.

OrderLineItemAppliedTax [ ]

calculation_phase

The calculation phase at which to apply the service charge.

string

Select calculation_phase

SUBTOTAL_PHASE The service charge is applied after discounts, but before taxes.

catalog_object_id

The catalog object ID referencing the service charge CatalogObject.

Max Length 192

string

catalog_version

The version of the catalog object that this service charge references.

integer

metadata

Application-defined data attached to this service charge. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

Map<string, string>

name

The name of the service charge.

Max Length 512

string

percentage

The service charge percentage as a string representation of a decimal number. For example, "7.25" indicates a service charge of 7.25%.

Exactly 1 of percentage or amount_money should be set.

Max Length 10

string

scope

Indicates the level at which the apportioned service charge applies. For ORDER scoped service charges, Square generates references in applied_service_charges on all order line items that do not have them. For LINE_ITEM scoped service charges, the service charge only applies to line items with a service charge reference in their applied_service_charges field.

This field is immutable. To change the scope of an apportioned service charge, you must delete the apportioned service charge and re-add it as a new apportioned service charge.

string

Select scope

OTHER_SERVICE_CHARGE_SCOPE Used for reporting only. The original transaction service charge scope is currently not supported by the API.
LINE_ITEM The service charge should be applied to only line items specified by OrderLineItemAppliedServiceCharge reference records.
ORDER The service charge should be applied to the entire order.

taxable

Indicates whether the service charge can be taxed. If set to true, order-level taxes automatically apply to the service charge. Note that service charges calculated in the TOTAL_PHASE cannot be marked as taxable.

boolean

uid

A unique ID that identifies the service charge only within this order.

Max Length 60

string

source

The origination details of the order.

OrderSource

state

The current state of the order.

string

Select state

OPEN Indicates that the order is open. Open orders can be updated.
COMPLETED Indicates that the order is completed. Completed orders are fully paid. This is a terminal state.
CANCELED Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state.
DRAFT Indicates that the order is in a draft state. Draft orders can be updated, but cannot be paid or fulfilled. For more information, see Create Orders.

taxes

The list of all taxes associated with the order.

Taxes can be scoped to either ORDER or LINE_ITEM. For taxes with LINE_ITEM scope, an OrderLineItemAppliedTax must be added to each line item that the tax applies to. For taxes with ORDER scope, the server generates an OrderLineItemAppliedTax for every line item.

On reads, each tax in the list includes the total amount of that tax applied to the order.

IMPORTANT: If LINE_ITEM scope is set on any taxes in this field, using the deprecated line_items.taxes field results in an error. Use line_items.applied_taxes instead.

OrderLineItemTax [ ]

ticket_name

A short-term identifier for the order (such as a customer first name, table number, or auto-generated order number that resets daily).

Max Length 30

string

version

The version number, which is incremented each time an update is committed to the order. Orders not created through the API do not include a version number and therefore cannot be updated.