action square_get_v2_orders_order_id { label: "RetrieveOrder" description: "Retrieves an [Order](https://developer.squareup.com/reference/square_2021-08-18/objects/Order) by ID." provider: square method: GET path: "/v2/orders/{order_id}" encoding: json input: { type: "object" properties: { order_id: { type: "string" } } required: ["order_id"] additionalProperties: false } output: { type: "object" properties: { errors: { type: "array" description: "Any errors that occurred during the request." items: { type: "object" description: "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information." required: ["category", "code"] properties: { category: { type: "string" description: "The high-level category for the error." } code: { type: "string" description: "The specific code of the error." } detail: { type: "string" description: "A human-readable description of the error for debugging purposes." } field: { type: "string" description: "The name of the field provided in the original request (if any) that\nthe error pertains to." } } } } order: { type: "object" description: "Contains all information related to a single order to process with Square,\nincluding line items that specify the products to purchase. `Order` objects also\ninclude information about any associated tenders, refunds, and returns.\n\nAll Connect V2 Transactions have all been converted to Orders including all associated\nitemization data." required: ["location_id"] properties: { closed_at: { type: "string" description: "The timestamp for when the order reached a terminal [state](https://developer.squareup.com/reference/square_2021-08-18/enums/OrderState), in RFC 3339 format (for example \"2016-09-04T23:59:33.123Z\")." } created_at: { type: "string" description: "The timestamp for when the order was created, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } customer_id: { type: "string" description: "The ID of the [customer](https://developer.squareup.com/reference/square_2021-08-18/objects/Customer) associated with the order.\n\n__IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions\nto be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the \n`customer_id` assigned to any underlying `Payment` objects is ignored and might result in the \ncreation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles)." } discounts: { type: "array" description: "The list of all discounts associated with the order.\n\nDiscounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,\nan `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.\nFor discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`\nfor every line item.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated\n`line_items.discounts` field results in an error. Use `line_items.applied_discounts`\ninstead." items: { type: "object" description: "Represents a discount that applies to one or more line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the\namount contributed by the item to the order subtotal." properties: { amount_money: { type: "object" description: "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information." properties: { amount: { type: "integer" format: "int64" description: "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case." } currency: { type: "string" description: "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values." } } } applied_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogDiscount)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this discount references." } metadata: { type: "object" description: "Application-defined data attached to this discount. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } name: { type: "string" description: "The discount's name." } percentage: { type: "string" description: "The percentage of the discount, as a string representation of a decimal number.\nA value of `7.25` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts." } pricing_rule_id: { type: "string" description: "The object ID of a [pricing rule](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogPricingRule) to be applied \nautomatically to this discount. The specification and application of the discounts, to \nwhich a `pricing_rule_id` is assigned, are completely controlled by the corresponding \npricing rule." } reward_ids: { type: "array" description: "The reward IDs corresponding to this discount. The application and\nspecification of discounts that have `reward_ids` are completely controlled by the backing\ncriteria corresponding to the reward tiers of the rewards that are added to the order\nthrough the Loyalty API. To manually unapply discounts that are the result of added rewards,\nthe rewards must be removed from the order through the Loyalty API." items: { type: "string" } } scope: { type: "string" description: "Indicates the level at which the discount applies. For `ORDER` scoped discounts,\nSquare generates references in `applied_discounts` on all order line items that do\nnot have them. For `LINE_ITEM` scoped discounts, the discount only applies to line items\nwith a discount reference in their `applied_discounts` field.\n\nThis field is immutable. To change the scope of a discount, you must delete\nthe discount and re-add it as a new discount." } type: { type: "string" description: "The type of the discount.\n\nDiscounts that do not reference a catalog object ID must have a type of\n`FIXED_PERCENTAGE` or `FIXED_AMOUNT`." } uid: { type: "string" description: "A unique ID that identifies the discount only within this order." } } } } fulfillments: { type: "array" description: "Details about order fulfillment.\n\nOrders can only be created with at most one fulfillment. However, orders returned\nby the API might contain multiple fulfillments." items: { type: "object" description: "Contains details about how to fulfill this order." properties: { metadata: { type: "object" description: "Application-defined data attached to this fulfillment. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } pickup_details: { type: "object" description: "Contains details necessary to fulfill a pickup order." properties: { accepted_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the fulfillment was accepted. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } auto_complete_duration: { type: "string" description: "The duration of time after which an open and accepted pickup fulfillment\nis automatically moved to the `COMPLETED` state. The duration must be in RFC 3339\nformat (for example, \"P1W3D\").\n\nIf not set, this pickup fulfillment remains accepted until it is canceled or completed." } cancel_reason: { type: "string" description: "A description of why the pickup was canceled. The maximum length: 100 characters." } canceled_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } curbside_pickup_details: { type: "object" description: "Specific details for curbside pickup." properties: { buyer_arrived_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } curbside_details: { type: "string" description: "Specific details for curbside pickup, such as parking number and vehicle model." } } } expired_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment expired. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } expires_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future.\nIf `expires_at` is not set, this pickup fulfillment is automatically accepted when \nplaced." } is_curbside_pickup: { type: "boolean" description: "If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup." } note: { type: "string" description: "A note meant to provide additional instructions about the pickup\nfulfillment displayed in the Square Point of Sale application and set by the API." } picked_up_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } pickup_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nthat represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \n\"2016-09-04T23:59:33.123Z\".\n\nFor fulfillments with the schedule type `ASAP`, this is automatically set\nto the current time plus the expected duration to prepare the fulfillment." } pickup_window_duration: { type: "string" description: "The window of time in which the order should be picked up after the `pickup_at` timestamp.\nMust be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an\ninformational guideline for merchants." } placed_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the fulfillment was placed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } prep_time_duration: { type: "string" description: "The duration of time it takes to prepare this fulfillment.\nThe duration must be in RFC 3339 format (for example, \"P1W3D\")." } ready_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } recipient: { type: "object" description: "Contains information about the recipient of a fulfillment." properties: { address: { type: "object" description: "Represents a postal address in a country. The address format is based \non an [open-source library from Google](https://github.com/google/libaddressinput). For more information, \nsee [AddressValidationMetadata](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata). \nThis format has dedicated fields for four address components: postal code, \nlocality (city), administrative district (state, prefecture, or province), and \nsublocality (town or village). These components have dedicated fields in the \n`Address` object because software sometimes behaves differently based on them. \nFor example, sales tax software may charge different amounts of sales tax \nbased on the postal code, and some software is only available in \ncertain states due to compliance reasons.\n\nFor the remaining address components, the `Address` type provides the \n`address_line_1` and `address_line_2` fields for free-form data entry. \nThese fields are free-form because the remaining address components have \ntoo many variations around the world and typical software does not parse \nthese components. These fields enable users to enter anything they want. \n\nNote that, in the current implementation, all other `Address` type fields are blank. \nThese include `address_line_3`, `sublocality_2`, `sublocality_3`, \n`administrative_district_level_2`, `administrative_district_level_3`, \n`first_name`, `last_name`, and `organization`. \n\nWhen it comes to localization, the seller's language preferences \n(see [Language preferences](https://developer.squareup.com/docs/locations-api#location-specific-and-seller-level-language-preferences)) \nare ignored for addresses. Even though Square products (such as Square Point of Sale \nand the Seller Dashboard) mostly use a seller's language preference in \ncommunication, when it comes to addresses, they will use English for a US address, \nJapanese for an address in Japan, and so on." properties: { address_line_1: { type: "string" description: "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)." } address_line_2: { type: "string" description: "The second line of the address, if any." } address_line_3: { type: "string" description: "The third line of the address, if any." } administrative_district_level_1: { type: "string" description: "A civil entity within the address's country. In the US, this\nis the state." } administrative_district_level_2: { type: "string" description: "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county." } administrative_district_level_3: { type: "string" description: "A civil entity within the address's `administrative_district_level_2`,\nif any." } country: { type: "string" description: "The address's country, in ISO 3166-1-alpha-2 format." } first_name: { type: "string" description: "Optional first name when it's representing recipient." } last_name: { type: "string" description: "Optional last name when it's representing recipient." } locality: { type: "string" description: "The city or town of the address." } organization: { type: "string" description: "Optional organization name when it's representing recipient." } postal_code: { type: "string" description: "The address's postal code." } sublocality: { type: "string" description: "A civil region within the address's `locality`, if any." } sublocality_2: { type: "string" description: "A civil region within the address's `sublocality`, if any." } sublocality_3: { type: "string" description: "A civil region within the address's `sublocality_2`, if any." } } } customer_id: { type: "string" description: "The customer ID of the customer associated with the fulfillment.\n\nIf `customer_id` is provided, the fulfillment recipient's `display_name`,\n`email_address`, and `phone_number` are automatically populated from the\ntargeted customer profile. If these fields are set in the request, the request\nvalues overrides the information from the customer profile. If the\ntargeted customer profile does not contain the necessary information and\nthese fields are left unset, the request results in an error." } display_name: { type: "string" description: "The display name of the fulfillment recipient.\n\nIf provided, the display name overrides the value pulled from the customer profile indicated by `customer_id`." } email_address: { type: "string" description: "The email address of the fulfillment recipient.\n\nIf provided, the email address overrides the value pulled from the customer profile indicated by `customer_id`." } phone_number: { type: "string" description: "The phone number of the fulfillment recipient.\n\nIf provided, the phone number overrides the value pulled from the customer profile indicated by `customer_id`." } } } rejected_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) \nindicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } schedule_type: { type: "string" description: "The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`." } } } shipment_details: { type: "object" description: "Contains the details necessary to fulfill a shipment order." properties: { cancel_reason: { type: "string" description: "A description of why the shipment was canceled." } canceled_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating the shipment was canceled.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } carrier: { type: "string" description: "The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS)." } expected_shipped_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment is expected to be delivered to the shipping carrier.\nThe timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } failed_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } failure_reason: { type: "string" description: "A description of why the shipment failed to be completed." } in_progress_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation\nof this shipment has begun. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } packaged_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `PREPARED` state, which indicates that the\nfulfillment is packaged. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } placed_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when the shipment was requested. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } recipient: { type: "object" additionalProperties: true } shipped_at: { type: "string" description: "The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)\nindicating when this fulfillment was moved to the `COMPLETED` state, which indicates that\nthe fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format\n(for example, \"2016-09-04T23:59:33.123Z\")." } shipping_note: { type: "string" description: "A note with additional information for the shipping carrier." } shipping_type: { type: "string" description: "A description of the type of shipping product purchased from the carrier\n(such as First Class, Priority, or Express)." } tracking_number: { type: "string" description: "The reference number provided by the carrier to track the shipment's progress." } tracking_url: { type: "string" description: "A link to the tracking webpage on the carrier's website." } } } state: { type: "string" description: "The state of the fulfillment." } type: { type: "string" description: "The type of the fulfillment." } uid: { type: "string" description: "A unique ID that identifies the fulfillment only within this order." } } } } id: { type: "string" description: "The order's unique ID." } line_items: { type: "array" description: "The line items included in the order." items: { type: "object" description: "Represents a line item in an order. Each line item describes a different\nproduct to purchase, with its own quantity and price details." required: ["quantity"] properties: { applied_discounts: { type: "array" description: "The list of references to discounts applied to this line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderLineItemDiscounts` applied to the line item. On reads, the amount\napplied is populated.\n\nAn `OrderLineItemAppliedDiscount` is automatically created on every line item for all\n`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records\nfor `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any\nline items.\n\nTo change the amount of a discount, modify the referenced top-level discount." items: { type: "object" description: "Represents an applied portion of a discount to a line item in an order.\n\nOrder scoped discounts have automatically applied discounts present for each line item.\nLine-item scoped discounts must have applied discounts added manually for any applicable line\nitems. The corresponding applied money is automatically computed based on participating\nline items." required: ["discount_uid"] properties: { applied_money: { type: "object" additionalProperties: true } discount_uid: { type: "string" description: "The `uid` of the discount that the applied discount represents. It must\nreference a discount present in the `order.discounts` field.\n\nThis field is immutable. To change which discounts apply to a line item,\nyou must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`." } uid: { type: "string" description: "A unique ID that identifies the applied discount only within this order." } } } } applied_taxes: { type: "array" description: "The list of references to taxes applied to this line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a\ntop-level `OrderLineItemTax` applied to the line item. On reads, the\namount applied is populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every line\nitem for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`\nrecords for `LINE_ITEM` scoped taxes must be added in requests for the tax\nto apply to any line items.\n\nTo change the amount of a tax, modify the referenced top-level tax." items: { type: "object" description: "Represents an applied portion of a tax to a line item in an order.\n\nOrder-scoped taxes automatically include the applied taxes in each line item.\nLine item taxes must be referenced from any applicable line items.\nThe corresponding applied money is automatically computed, based on the\nset of participating line items." required: ["tax_uid"] properties: { applied_money: { type: "object" additionalProperties: true } tax_uid: { type: "string" description: "The `uid` of the tax for which this applied tax represents. It must reference\na tax present in the `order.taxes` field.\n\nThis field is immutable. To change which taxes apply to a line item, delete and add a new\n`OrderLineItemAppliedTax`." } uid: { type: "string" description: "A unique ID that identifies the applied tax only within this order." } } } } base_price_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation) ID applied to this line item." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this line item references." } gross_sales_money: { type: "object" additionalProperties: true } item_type: { type: "string" description: "The type of line item: an itemized sale, a non-itemized sale (custom amount), or the\nactivation or reloading of a gift card." } metadata: { type: "object" description: "Application-defined data attached to this line item. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } modifiers: { type: "array" description: "The [CatalogModifier](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogModifier)s applied to this line item." items: { type: "object" description: "A [CatalogModifier](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogModifier)." properties: { base_price_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The catalog object ID referencing [CatalogModifier](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogModifier)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this modifier references." } name: { type: "string" description: "The name of the item modifier." } total_price_money: { type: "object" additionalProperties: true } uid: { type: "string" description: "A unique ID that identifies the modifier only within this order." } } } } name: { type: "string" description: "The name of the line item." } note: { type: "string" description: "The note of the line item." } pricing_blocklists: { type: "object" description: "Describes pricing adjustments that are blocked from manual and \nautomatic application to a line item. For more information, see \n[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts)." properties: { blocked_discounts: { type: "array" description: "A list of discounts blocked from applying to the line item. \nDiscounts can be blocked by the `discount_uid` (for ad hoc discounts) or \nthe `discount_catalog_object_id` (for catalog discounts)." items: { type: "object" description: "A discount to block from applying to a line item. The discount must be \nidentified by either `discount_uid` or `discount_catalog_object_id`, but not both." properties: { discount_catalog_object_id: { type: "string" description: "The `catalog_object_id` of the discount that should be blocked. \nUse this field to block catalog discounts. For ad hoc discounts, use the \n`discount_uid` field." } discount_uid: { type: "string" description: "The `uid` of the discount that should be blocked. Use this field to block \nad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field." } uid: { type: "string" description: "A unique ID of the `BlockedDiscount` within the order." } } } } blocked_taxes: { type: "array" description: "A list of taxes blocked from applying to the line item. \nTaxes can be blocked by the `tax_uid` (for ad hoc taxes) or \nthe `tax_catalog_object_id` (for catalog taxes)." items: { type: "object" description: "A tax to block from applying to a line item. The tax must be \nidentified by either `tax_uid` or `tax_catalog_object_id`, but not both." properties: { tax_catalog_object_id: { type: "string" description: "The `catalog_object_id` of the tax that should be blocked. \nUse this field to block catalog taxes. For ad hoc taxes, use the \n`tax_uid` field." } tax_uid: { type: "string" description: "The `uid` of the tax that should be blocked. Use this field to block \nad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field." } uid: { type: "string" description: "A unique ID of the `BlockedTax` within the order." } } } } } } quantity: { type: "string" description: "The quantity purchased, formatted as a decimal number.\nFor example, `\"3\"`.\n\nLine items with a quantity of `\"0\"` are automatically removed\nwhen paying for or otherwise completing the order.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `\"1.70000\"`." } quantity_unit: { type: "object" description: "Contains the measurement unit for a quantity and a precision that\nspecifies the number of digits after the decimal point for decimal quantities." properties: { catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this measurement unit references.\n\nThis field is set when this is a catalog-backed measurement unit." } measurement_unit: { type: "object" description: "Represents a unit of measurement to use with a quantity, such as ounces\nor inches. Exactly one of the following fields are required: `custom_unit`,\n`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`." properties: { area_unit: { type: "string" description: "Represents a standard area unit." } custom_unit: { type: "object" description: "The information needed to define a custom unit, provided by the seller." required: ["name", "abbreviation"] properties: { abbreviation: { type: "string" description: "The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears\nin the cart for the Point of Sale app, and in reports." } name: { type: "string" description: "The name of the custom unit, for example \"bushel\"." } } } generic_unit: { type: "string" description: "Reserved for API integrations that lack the ability to specify a real measurement unit" } length_unit: { type: "string" description: "Represents a standard length unit." } time_unit: { type: "string" description: "Represents a standard unit of time." } type: { type: "string" description: "Represents the type of the measurement unit." } volume_unit: { type: "string" description: "Represents a standard volume unit." } weight_unit: { type: "string" description: "Represents a standard unit of weight or mass." } } } precision: { type: "integer" description: "For non-integer quantities, represents the number of digits after the decimal point that are\nrecorded for this quantity.\n\nFor example, a precision of 1 allows quantities such as `\"1.0\"` and `\"1.1\"`, but not `\"1.01\"`.\n\nMin: 0. Max: 5." } } } total_discount_money: { type: "object" additionalProperties: true } total_money: { type: "object" additionalProperties: true } total_tax_money: { type: "object" additionalProperties: true } uid: { type: "string" description: "A unique ID that identifies the line item only within this order." } variation_name: { type: "string" description: "The name of the variation applied to this line item." } variation_total_price_money: { type: "object" additionalProperties: true } } } } location_id: { type: "string" description: "The ID of the seller location that this order is associated with." } metadata: { type: "object" description: "Application-defined data attached to this order. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } net_amounts: { type: "object" description: "A collection of various money amounts." properties: { discount_money: { type: "object" additionalProperties: true } service_charge_money: { type: "object" additionalProperties: true } tax_money: { type: "object" additionalProperties: true } tip_money: { type: "object" additionalProperties: true } total_money: { type: "object" additionalProperties: true } } } pricing_options: { type: "object" description: "Pricing options for an order. The options affect how the order's price is calculated.\nThey can be used, for example, to apply automatic price adjustments that are based on preconfigured\n[pricing rules](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogPricingRule)." properties: { auto_apply_discounts: { type: "boolean" description: "The option to determine whether pricing rule-based\ndiscounts are automatically applied to an order." } auto_apply_taxes: { type: "boolean" description: "The option to determine whether rule-based taxes are automatically\napplied to an order when the criteria of the corresponding rules are met." } } } reference_id: { type: "string" description: "A client-specified ID to associate an entity in another system\nwith this order." } refunds: { type: "array" description: "The refunds that are part of this order." items: { type: "object" description: "Represents a refund processed for a Square transaction." required: ["id", "location_id", "transaction_id", "tender_id", "reason", "amount_money", "status"] properties: { additional_recipients: { type: "array" description: "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration." items: { type: "object" description: "Represents an additional recipient (other than the merchant) receiving a portion of this tender." required: ["location_id", "amount_money"] properties: { amount_money: { type: "object" additionalProperties: true } description: { type: "string" description: "The description of the additional recipient." } location_id: { type: "string" description: "The location ID for a recipient (other than the merchant) receiving a portion of this tender." } receivable_id: { type: "string" description: "The unique ID for this [AdditionalRecipientReceivable](https://developer.squareup.com/reference/square_2021-08-18/objects/AdditionalRecipientReceivable), assigned by the server." } } } } amount_money: { type: "object" additionalProperties: true } created_at: { type: "string" description: "The timestamp for when the refund was created, in RFC 3339 format." } id: { type: "string" description: "The refund's unique ID." } location_id: { type: "string" description: "The ID of the refund's associated location." } processing_fee_money: { type: "object" additionalProperties: true } reason: { type: "string" description: "The reason for the refund being issued." } status: { type: "string" description: "The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`,\nor `FAILED`)." } tender_id: { type: "string" description: "The ID of the refunded tender." } transaction_id: { type: "string" description: "The ID of the transaction that the refunded tender is part of." } } } } return_amounts: { type: "object" additionalProperties: true } returns: { type: "array" description: "A collection of items from sale orders being returned in this one. Normally part of an\nitemized return or exchange. There is exactly one `Return` object per sale `Order` being\nreferenced." items: { type: "object" description: "The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order." properties: { return_amounts: { type: "object" additionalProperties: true } return_discounts: { type: "array" description: "A collection of references to discounts being returned for an order, including the total\napplied discount amount to be returned. The discounts must reference a top-level discount ID\nfrom the source order." items: { type: "object" description: "Represents a discount being returned that applies to one or more return line items in an\norder.\n\nFixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item’s contribution to the\norder subtotal." properties: { amount_money: { type: "object" additionalProperties: true } applied_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The catalog object ID referencing [CatalogDiscount](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogDiscount)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this discount references." } name: { type: "string" description: "The discount's name." } percentage: { type: "string" description: "The percentage of the tax, as a string representation of a decimal number.\nA value of `\"7.25\"` corresponds to a percentage of 7.25%.\n\n`percentage` is not set for amount-based discounts." } scope: { type: "string" description: "Indicates the level at which the `OrderReturnDiscount` applies. For `ORDER` scoped\ndiscounts, the server generates references in `applied_discounts` on all\n`OrderReturnLineItem`s. For `LINE_ITEM` scoped discounts, the discount is only applied to\n`OrderReturnLineItem`s with references in their `applied_discounts` field." } source_discount_uid: { type: "string" description: "The discount `uid` from the order that contains the original application of this discount." } type: { type: "string" description: "The type of the discount. If it is created by the API, it is `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.\n\nDiscounts that do not reference a catalog object ID must have a type of\n`FIXED_PERCENTAGE` or `FIXED_AMOUNT`." } uid: { type: "string" description: "A unique ID that identifies the returned discount only within this order." } } } } return_line_items: { type: "array" description: "A collection of line items that are being returned." items: { type: "object" description: "The line item being returned in an order." required: ["quantity"] properties: { applied_discounts: { type: "array" description: "The list of references to `OrderReturnDiscount` entities applied to the return line item. Each\n`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level\n`OrderReturnDiscount` applied to the return line item. On reads, the applied amount\nis populated." items: { type: "object" additionalProperties: true } } applied_taxes: { type: "array" description: "The list of references to `OrderReturnTax` entities applied to the return line item. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderReturnTax` applied to the return line item. On reads, the applied amount\nis populated." items: { type: "object" additionalProperties: true } } base_price_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The [CatalogItemVariation](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogItemVariation) ID applied to this return line item." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this line item references." } gross_return_money: { type: "object" additionalProperties: true } item_type: { type: "string" description: "The type of line item: an itemized return, a non-itemized return (custom amount),\nor the return of an unactivated gift card sale." } name: { type: "string" description: "The name of the line item." } note: { type: "string" description: "The note of the return line item." } quantity: { type: "string" description: "The quantity returned, formatted as a decimal number.\nFor example, `\"3\"`.\n\nLine items with a `quantity_unit` can have non-integer quantities.\nFor example, `\"1.70000\"`." } quantity_unit: { type: "object" additionalProperties: true } return_modifiers: { type: "array" description: "The [CatalogModifier](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogModifier)s applied to this line item." items: { type: "object" description: "A line item modifier being returned." properties: { base_price_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "object" additionalProperties: true } catalog_version: { type: "object" additionalProperties: true } name: { type: "object" additionalProperties: true } source_modifier_uid: { type: "object" additionalProperties: true } total_price_money: { type: "object" additionalProperties: true } uid: { type: "object" additionalProperties: true } } } } source_line_item_uid: { type: "string" description: "The `uid` of the line item in the original sale order." } total_discount_money: { type: "object" additionalProperties: true } total_money: { type: "object" additionalProperties: true } total_tax_money: { type: "object" additionalProperties: true } uid: { type: "string" description: "A unique ID for this return line-item entry." } variation_name: { type: "string" description: "The name of the variation applied to this return line item." } variation_total_price_money: { type: "object" additionalProperties: true } } } } return_service_charges: { type: "array" description: "A collection of service charges that are being returned." items: { type: "object" description: "Represents the service charge applied to the original order." properties: { amount_money: { type: "object" additionalProperties: true } applied_money: { type: "object" additionalProperties: true } applied_taxes: { type: "array" description: "The list of references to `OrderReturnTax` entities applied to the\n`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`\nthat references the `uid` of a top-level `OrderReturnTax` that is being\napplied to the `OrderReturnServiceCharge`. On reads, the applied amount is\npopulated." items: { type: "object" additionalProperties: true } } calculation_phase: { type: "string" description: "The calculation phase after which to apply the service charge." } catalog_object_id: { type: "string" description: "The catalog object ID of the associated [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-08-18/objects/OrderServiceCharge)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this service charge references." } name: { type: "string" description: "The name of the service charge." } percentage: { type: "string" description: "The percentage of the service charge, as a string representation of\na decimal number. For example, a value of `\"7.25\"` corresponds to a\npercentage of 7.25%.\n\nEither `percentage` or `amount_money` should be set, but not both." } source_service_charge_uid: { type: "string" description: "The service charge `uid` from the order containing the original\nservice charge. `source_service_charge_uid` is `null` for\nunlinked returns." } taxable: { type: "boolean" description: "Indicates whether the surcharge can be taxed. Service charges\ncalculated in the `TOTAL_PHASE` cannot be marked as taxable." } total_money: { type: "object" additionalProperties: true } total_tax_money: { type: "object" additionalProperties: true } uid: { type: "string" description: "A unique ID that identifies the return service charge only within this order." } } } } return_taxes: { type: "array" description: "A collection of references to taxes being returned for an order, including the total\napplied tax amount to be returned. The taxes must reference a top-level tax ID from the source\norder." items: { type: "object" description: "Represents a tax being returned that applies to one or more return line items in an order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.\nThe amount distributed to each return line item is relative to that item’s contribution to the\norder subtotal." properties: { applied_money: { type: "object" additionalProperties: true } catalog_object_id: { type: "string" description: "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogTax)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this tax references." } name: { type: "string" description: "The tax's name." } percentage: { type: "string" description: "The percentage of the tax, as a string representation of a decimal number.\nFor example, a value of `\"7.25\"` corresponds to a percentage of 7.25%." } scope: { type: "string" description: "Indicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped\ntaxes, Square generates references in `applied_taxes` on all\n`OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax is only applied to\n`OrderReturnLineItem`s with references in their `applied_discounts` field." } source_tax_uid: { type: "string" description: "The tax `uid` from the order that contains the original tax charge." } type: { type: "string" description: "Indicates the calculation method used to apply the tax." } uid: { type: "string" description: "A unique ID that identifies the returned tax only within this order." } } } } rounding_adjustment: { type: "object" description: "A rounding adjustment of the money being returned. Commonly used to apply cash rounding\nwhen the minimum unit of the account is smaller than the lowest physical denomination of the currency." properties: { amount_money: { type: "object" additionalProperties: true } name: { type: "string" description: "The name of the rounding adjustment from the original sale order." } uid: { type: "string" description: "A unique ID that identifies the rounding adjustment only within this order." } } } source_order_id: { type: "string" description: "An order that contains the original sale of these return line items. This is unset\nfor unlinked returns." } uid: { type: "string" description: "A unique ID that identifies the return only within this order." } } } } rewards: { type: "array" description: "A set-like list of Rewards that have been added to the Order." items: { type: "object" description: "Represents a reward that can be applied to an order if the necessary\nreward tier criteria are met. Rewards are created through the Loyalty API." required: ["id", "reward_tier_id"] properties: { id: { type: "string" description: "The identifier of the reward." } reward_tier_id: { type: "string" description: "The identifier of the reward tier corresponding to this reward." } } } } rounding_adjustment: { type: "object" additionalProperties: true } service_charges: { type: "array" description: "A list of service charges applied to the order." items: { type: "object" description: "Represents a service charge applied to an order." properties: { amount_money: { type: "object" additionalProperties: true } applied_money: { type: "object" additionalProperties: true } applied_taxes: { type: "array" description: "The list of references to the taxes applied to this service charge. Each\n`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level\n`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied\nis populated.\n\nAn `OrderLineItemAppliedTax` is automatically created on every taxable service charge\nfor all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records\nfor `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable\nservice charge. Taxable service charges have the `taxable` field set to `true` and calculated\nin the `SUBTOTAL_PHASE`.\n\nTo change the amount of a tax, modify the referenced top-level tax." items: { type: "object" additionalProperties: true } } calculation_phase: { type: "string" description: "The calculation phase at which to apply the service charge." } catalog_object_id: { type: "string" description: "The catalog object ID referencing the service charge [CatalogObject](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogObject)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this service charge references." } metadata: { type: "object" description: "Application-defined data attached to this service charge. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } name: { type: "string" description: "The name of the service charge." } percentage: { type: "string" description: "The service charge percentage as a string representation of a\ndecimal number. For example, `\"7.25\"` indicates a service charge of 7.25%.\n\nExactly 1 of `percentage` or `amount_money` should be set." } taxable: { type: "boolean" description: "Indicates whether the service charge can be taxed. If set to `true`,\norder-level taxes automatically apply to the service charge. Note that\nservice charges calculated in the `TOTAL_PHASE` cannot be marked as taxable." } total_money: { type: "object" additionalProperties: true } total_tax_money: { type: "object" additionalProperties: true } type: { type: "string" description: "The type of the service charge." } uid: { type: "string" description: "A unique ID that identifies the service charge only within this order." } } } } source: { type: "object" description: "Represents the origination details of an order." properties: { name: { type: "string" description: "The name used to identify the place (physical or digital) that an order originates.\nIf unset, the name defaults to the name of the application that created the order." } } } state: { type: "string" description: "The current state of the order: `OPEN`, `COMPLETED`, or `CANCELED`." } taxes: { type: "array" description: "The list of all taxes associated with the order.\n\nTaxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an\n`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes\nwith `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.\n\nOn reads, each tax in the list includes the total amount of that tax applied to the order.\n\n__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated\n`line_items.taxes` field results in an error. Use `line_items.applied_taxes`\ninstead." items: { type: "object" description: "Represents a tax that applies to one or more line item in the order.\n\nFixed-amount, order-scoped taxes are distributed across all non-zero line item totals.\nThe amount distributed to each line item is relative to the amount the item\ncontributes to the order subtotal." properties: { applied_money: { type: "object" additionalProperties: true } auto_applied: { type: "boolean" description: "Determines whether the tax was automatically applied to the order based on\nthe catalog configuration. For an example, see \n[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes)." } catalog_object_id: { type: "string" description: "The catalog object ID referencing [CatalogTax](https://developer.squareup.com/reference/square_2021-08-18/objects/CatalogTax)." } catalog_version: { type: "integer" format: "int64" description: "The version of the catalog object that this tax references." } metadata: { type: "object" description: "Application-defined data attached to this tax. Metadata fields are intended\nto store descriptive references or associations with an entity in another system or store brief\ninformation about the object. Square does not process this field; it only stores and returns it\nin relevant API calls. Do not use metadata to store any sensitive information (such as personally\nidentifiable information or card details).\n\nKeys written by applications must be 60 characters or less and must be in the character set\n`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed\nwith a namespace, separated from the key with a ':' character.\n\nValues have a maximum length of 255 characters.\n\nAn application can have up to 10 entries per metadata field.\n\nEntries written by applications are private and can only be read or modified by the same\napplication.\n\nFor more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata)." } name: { type: "string" description: "The tax's name." } percentage: { type: "string" description: "The percentage of the tax, as a string representation of a decimal\nnumber. For example, a value of `\"7.25\"` corresponds to a percentage of\n7.25%." } scope: { type: "string" description: "Indicates the level at which the tax applies. For `ORDER` scoped taxes,\nSquare generates references in `applied_taxes` on all order line items that do\nnot have them. For `LINE_ITEM` scoped taxes, the tax only applies to line items\nwith references in their `applied_taxes` field.\n\nThis field is immutable. To change the scope, you must delete the tax and\nre-add it as a new tax." } type: { type: "string" description: "Indicates the calculation method used to apply the tax." } uid: { type: "string" description: "A unique ID that identifies the tax only within this order." } } } } tenders: { type: "array" description: "The tenders that were used to pay for the order." items: { type: "object" description: "Represents a tender (i.e., a method of payment) used in a Square transaction." required: ["type"] properties: { additional_recipients: { type: "array" description: "Additional recipients (other than the merchant) receiving a portion of this tender.\nFor example, fees assessed on the purchase by a third party integration." items: { type: "object" additionalProperties: true } } amount_money: { type: "object" additionalProperties: true } card_details: { type: "object" description: "Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`" properties: { card: { type: "object" description: "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK." properties: { billing_address: { type: "object" additionalProperties: true } bin: { type: "string" description: "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field." } card_brand: { type: "string" description: "The card's brand." } card_type: { type: "string" description: "The type of the card.\nThe Card object includes this field only in response to Payments API calls." } cardholder_name: { type: "string" description: "The name of the cardholder." } customer_id: { type: "string" description: "The ID of a customer created using the Customers API to be associated with the card." } enabled: { type: "boolean" description: "Indicates whether or not a card can be used for payments." } exp_month: { type: "integer" format: "int64" description: "The expiration month of the associated card as an integer between 1 and 12." } exp_year: { type: "integer" format: "int64" description: "The four-digit year of the card's expiration date." } fingerprint: { type: "string" description: "__Not currently set.__ Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application." } id: { type: "string" description: "Unique ID for this card. Generated by Square." } last_4: { type: "string" description: "The last 4 digits of the card number." } prepaid_type: { type: "string" description: "Indicates whether the Card is prepaid or not.\nThe Card object includes this field only in response to Payments API calls." } reference_id: { type: "string" description: "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system." } version: { type: "integer" format: "int64" description: "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card." } } } entry_method: { type: "string" description: "The method used to enter the card's details for the transaction." } status: { type: "string" description: "The credit card payment's current state (such as `AUTHORIZED` or\n`CAPTURED`). See [TenderCardDetailsStatus](https://developer.squareup.com/reference/square_2021-08-18/objects/TenderCardDetailsStatus)\nfor possible values." } } } cash_details: { type: "object" description: "Represents the details of a tender with `type` `CASH`." properties: { buyer_tendered_money: { type: "object" additionalProperties: true } change_back_money: { type: "object" additionalProperties: true } } } created_at: { type: "string" description: "The timestamp for when the tender was created, in RFC 3339 format." } customer_id: { type: "string" description: "If the tender is associated with a customer or represents a customer's card on file,\nthis is the ID of the associated customer." } id: { type: "string" description: "The tender's unique ID." } location_id: { type: "string" description: "The ID of the transaction's associated location." } note: { type: "string" description: "An optional note associated with the tender at the time of payment." } payment_id: { type: "string" description: "The ID of the [Payment](https://developer.squareup.com/reference/square_2021-08-18/objects/Payment) that corresponds to this tender.\nThis value is only present for payments created with the v2 Payments API." } processing_fee_money: { type: "object" additionalProperties: true } tip_money: { type: "object" additionalProperties: true } transaction_id: { type: "string" description: "The ID of the tender's associated transaction." } type: { type: "string" description: "The type of tender, such as `CARD` or `CASH`." } } } } total_discount_money: { type: "object" additionalProperties: true } total_money: { type: "object" additionalProperties: true } total_service_charge_money: { type: "object" additionalProperties: true } total_tax_money: { type: "object" additionalProperties: true } total_tip_money: { type: "object" additionalProperties: true } updated_at: { type: "string" description: "The timestamp for when the order was last updated, in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\")." } version: { type: "integer" description: "The version number, which is incremented each time an update is committed to the order.\nOrders not created through the API do not include a version number and\ntherefore cannot be updated.\n\n[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders#update-orders)." } } } } } }