Square Orders API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Orders API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: Orders
paths:
  /v2/orders:
    post:
      tags:
      - Orders
      summary: Square Create Order
      operationId: CreateOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a new [order](entity:Order) that can include information about products for

        purchase and settings to apply to the purchase.


        To pay for a created order, see

        [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).


        You can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderResponse'
  /v2/orders/batch-retrieve:
    post:
      tags:
      - Orders
      summary: Square Batch Retrieve Orders
      operationId: BatchRetrieveOrders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a set of [orders](entity:Order) by their IDs.


        If a given order ID does not exist, the ID is ignored instead of generating an error.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveOrdersRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveOrdersResponse'
  /v2/orders/calculate:
    post:
      tags:
      - Orders
      summary: Square Calculate Order
      operationId: CalculateOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Enables applications to preview order pricing without creating an order.
      x-release-status: BETA
      security:
      - oauth2: []
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateOrderRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateOrderResponse'
  /v2/orders/clone:
    post:
      tags:
      - Orders
      summary: Square Clone Order
      operationId: CloneOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has

        only the core fields (such as line items, taxes, and discounts) copied from the original order.'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneOrderRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneOrderResponse'
  /v2/orders/search:
    post:
      tags:
      - Orders
      summary: Square Search Orders
      operationId: SearchOrders
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](entity:SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n  Set filter criteria.\n  Set the sort order.\n  Determine whether to return results as complete `Order` objects or as\n[OrderEntry](entity:OrderEntry) objects.\n\nNote that details for orders processed with Square Point of Sale while in\noffline mode might not be transmitted to Square for up to 72 hours. Offline\norders have a `created_at` value that reflects the time the order was created,\nnot the time it was subsequently transmitted to Square."
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchOrdersRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchOrdersResponse'
  /v2/orders/{order_id}:
    get:
      tags:
      - Orders
      summary: Square Retrieve Order
      operationId: RetrieveOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves an [Order](entity:Order) by ID.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: order_id
        description: The ID of the order to retrieve.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveOrderResponse'
    put:
      tags:
      - Orders
      summary: Square Update Order
      operationId: UpdateOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates an open [order](entity:Order) by adding, replacing, or deleting

        fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.


        An `UpdateOrder` request requires the following:


        - The `order_id` in the endpoint path, identifying the order to update.

        - The latest `version` of the order to update.

        - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)

        containing only the fields to update and the version to which the update is

        being applied.

        - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)

        identifying the fields to clear.


        To pay for an order, see

        [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).'
      x-release-status: BETA
      security:
      - oauth2:
        - ORDERS_WRITE
      parameters:
      - name: order_id
        description: The ID of the order to update.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrderRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrderResponse'
  /v2/orders/{order_id}/pay:
    post:
      tags:
      - Orders
      summary: Square Pay Order
      operationId: PayOrder
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment)

        or settle an order with a total of `0`.


        The total of the `payment_ids` listed in the request must be equal to the order

        total. Orders with a total amount of `0` can be marked as paid by specifying an empty

        array of `payment_ids` in the request.


        To be used with `PayOrder`, a payment must:


        - Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment).

        Any approved payments that reference the same `order_id` not specified in the

        `payment_ids` is canceled.

        - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture).

        Using a delayed capture payment with `PayOrder` completes the approved payment.'
      x-release-status: BETA
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_WRITE
      parameters:
      - name: order_id
        description: The ID of the order being paid.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayOrderRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayOrderResponse'
components:
  schemas:
    Currency:
      type: string
      enum:
      - UNKNOWN_CURRENCY
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SLE
      - SOS
      - SRD
      - SSP
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - USS
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMK
      - ZMW
      - BTC
      - XUS
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
      - name: AED
        description: United Arab Emirates dirham
      - name: AFN
        description: Afghan afghani
      - name: ALL
        description: Albanian lek
      - name: AMD
        description: Armenian dram
      - name: ANG
        description: Netherlands Antillean guilder
      - name: AOA
        description: Angolan kwanza
      - name: ARS
        description: Argentine peso
      - name: AUD
        description: Australian dollar
      - name: AWG
        description: Aruban florin
      - name: AZN
        description: Azerbaijani manat
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
      - name: BBD
        description: Barbados dollar
      - name: BDT
        description: Bangladeshi taka
      - name: BGN
        description: Bulgarian lev
      - name: BHD
        description: Bahraini dinar
      - name: BIF
        description: Burundian franc
      - name: BMD
        description: Bermudian dollar
      - name: BND
        description: Brunei dollar
      - name: BOB
        description: Boliviano
      - name: BOV
        description: Bolivian Mvdol
      - name: BRL
        description: Brazilian real
      - name: BSD
        description: Bahamian dollar
      - name: BTN
        description: Bhutanese ngultrum
      - name: BWP
        description: Botswana pula
      - name: BYR
        description: Belarusian ruble
      - name: BZD
        description: Belize dollar
      - name: CAD
        description: Canadian dollar
      - name: CDF
        description: Congolese franc
      - name: CHE
        description: WIR Euro
      - name: CHF
        description: Swiss franc
      - name: CHW
        description: WIR Franc
      - name: CLF
        description: Unidad de Fomento
      - name: CLP
        description: Chilean peso
      - name: CNY
        description: Chinese yuan
      - name: COP
        description: Colombian peso
      - name: COU
        description: Unidad de Valor Real
      - name: CRC
        description: Costa Rican colon
      - name: CUC
        description: Cuban convertible peso
      - name: CUP
        description: Cuban peso
      - name: CVE
        description: Cape Verdean escudo
      - name: CZK
        description: Czech koruna
      - name: DJF
        description: Djiboutian franc
      - name: DKK
        description: Danish krone
      - name: DOP
        description: Dominican peso
      - name: DZD
        description: Algerian dinar
      - name: EGP
        description: Egyptian pound
      - name: ERN
        description: Eritrean nakfa
      - name: ETB
        description: Ethiopian birr
      - name: EUR
        description: Euro
      - name: FJD
        description: Fiji dollar
      - name: FKP
        description: Falkland Islands pound
      - name: GBP
        description: Pound sterling
      - name: GEL
        description: Georgian lari
      - name: GHS
        description: Ghanaian cedi
      - name: GIP
        description: Gibraltar pound
      - name: GMD
        description: Gambian dalasi
      - name: GNF
        description: Guinean franc
      - name: GTQ
        description: Guatemalan quetzal
      - name: GYD
        description: Guyanese dollar
      - name: HKD
        description: Hong Kong dollar
      - name: HNL
        description: Honduran lempira
      - name: HRK
        description: Croatian kuna
      - name: HTG
        description: Haitian gourde
      - name: HUF
        description: Hungarian forint
      - name: IDR
        description: Indonesian rupiah
      - name: ILS
        description: Israeli new shekel
      - name: INR
        description: Indian rupee
      - name: IQD
        description: Iraqi dinar
      - name: IRR
        description: Iranian rial
      - name: ISK
        description: Icelandic króna
      - name: JMD
        description: Jamaican dollar
      - name: JOD
        description: Jordanian dinar
      - name: JPY
        description: Japanese yen
      - name: KES
        description: Kenyan shilling
      - name: KGS
        description: Kyrgyzstani som
      - name: KHR
        description: Cambodian riel
      - name: KMF
        description: Comoro franc
      - name: KPW
        description: North Korean won
      - name: KRW
        description: South Korean won
      - name: KWD
        description: Kuwaiti dinar
      - name: KYD
        description: Cayman Islands dollar
      - name: KZT
        description: Kazakhstani tenge
      - name: LAK
        description: Lao kip
      - name: LBP
        description: Lebanese pound
      - name: LKR
        description: Sri Lankan rupee
      - name: LRD
        description: Liberian dollar
      - name: LSL
        description: Lesotho loti
      - name: LTL
        description: Lithuanian litas
      - name: LVL
        description: Latvian lats
      - name: LYD
        description: Libyan dinar
      - name: MAD
        description: Moroccan dirham
      - name: MDL
        description: Moldovan leu
      - name: MGA
        description: Malagasy ariary
      - name: MKD
        description: Macedonian denar
      - name: MMK
        description: Myanmar kyat
      - name: MNT
        description: Mongolian tögrög
      - name: MOP
        description: Macanese pataca
      - name: MRO
        description: Mauritanian ouguiya
      - name: MUR
        description: Mauritian rupee
      - name: MVR
        description: Maldivian rufiyaa
      - name: MWK
        description: Malawian kwacha
      - name: MXN
        description: Mexican peso
      - name: MXV
        description: Mexican Unidad de Inversion
      - name: MYR
        description: Malaysian ringgit
      - name: MZN
        description: Mozambican metical
      - name: NAD
        description: Namibian dollar
      - name: NGN
        description: Nigerian naira
      - name: NIO
        description: Nicaraguan córdoba
      - name: NOK
        description: Norwegian krone
      - name: NPR
        description: Nepalese rupee
      - name: NZD
        description: New Zealand dollar
      - name: OMR
        description: Omani rial
      - name: PAB
        description: Panamanian balboa
      - name: PEN
        description: Peruvian sol
      - name: PGK
        description: Papua New Guinean kina
      - name: PHP
        description: Philippine peso
      - name: PKR
        description: Pakistani rupee
      - name: PLN
        description: Polish zBoty
      - name: PYG
        description: Paraguayan guaraní
      - name: QAR
        description: Qatari riyal
      - name: RON
        description: Romanian leu
      - name: RSD
        description: Serbian dinar
      - name: RUB
        description: Russian ruble
      - name: RWF
        description: Rwandan franc
      - name: SAR
        description: Saudi riyal
      - name: SBD
        description: Solomon Islands dollar
      - name: SCR
        description: Seychelles rupee
      - name: SDG
        description: Sudanese pound
      - name: SEK
        description: Swedish krona
      - name: SGD
        description: Singapore dollar
      - name: SHP
        description: Saint Helena pound
      - name: SLL
        description: Sierra Leonean first leone
      - name: SLE
        description: Sierra Leonean second leone
      - name: SOS
        description: Somali shilling
      - name: SRD
        description: Surinamese dollar
      - name: SSP
        description: South Sudanese pound
      - name: STD
        description: São Tomé and Príncipe dobra
      - name: SVC
        description: Salvadoran colón
      - name: SYP
        description: Syrian pound
      - name: SZL
        description: Swazi lilangeni
      - name: THB
        description: Thai baht
      - name: TJS
        description: Tajikstani somoni
      - name: TMT
        description: Turkmenistan manat
      - name: TND
        description: Tunisian dinar
      - name: TOP
        description: Tongan pa'anga
      - name: TRY
        description: Turkish lira
      - name: TTD
        description: Trinidad and Tobago dollar
      - name: TWD
        description: New Taiwan dollar
      - name: TZS
        description: Tanzanian shilling
      - name: UAH
        description: Ukrainian hryvnia
      - name: UGX
        description: Ugandan shilling
      - name: USD
        description: United States dollar
      - name: USN
        description: United States dollar (next day)
      - name: USS
        description: United States dollar (same day)
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
      - name: UYU
        description: Uruguyan peso
      - name: UZS
        description: Uzbekistan som
      - name: VEF
        description: Venezuelan bolívar soberano
      - name: VND
        description: Vietnamese ’Óng
      - name: VUV
        description: Vanuatu vatu
      - name: WST
        description: Samoan tala
      - name: XAF
        description: CFA franc BEAC
      - name: XAG
        description: Silver
      - name: XAU
        description: Gold
      - name: XBA
        description: European Composite Unit
      - name: XBB
        description: European Monetary Unit
      - name: XBC
        description: European Unit of Account 9
      - name: XBD
        description: European Unit of Account 17
      - name: XCD
        description: East Caribbean dollar
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
      - name: XOF
        description: CFA franc BCEAO
      - name: XPD
        description: Palladium
      - name: XPF
        description: CFP franc
      - name: XPT
        description: Platinum
      - name: XTS
        description: Code reserved for testing
      - name: XXX
        description: No currency
      - name: YER
        description: Yemeni rial
      - name: ZAR
        description: South African rand
      - name: ZMK
        description: Zambian kwacha
      - name: ZMW
        description: Zambian kwacha
      - name: BTC
        description: Bitcoin
      - name: XUS
        description: USD Coin
      description: 'Indicates the associated currency for an amount of money. Values correspond

        to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).'
      x-release-status: PUBLIC
    SearchOrdersStateFilter:
      type: object
      description: Filter by the current order `state`.
      x-release-status: PUBLIC
      required:
      - states
      properties:
        states:
          type: array
          items:
            $ref: '#/components/schemas/OrderState'
          description: 'States to filter for.

            See [OrderState](#type-orderstate) for possible values'
    OrderReturnTip:
      type: object
      description: A tip being returned.
      x-release-status: BETA
      properties:
        uid:
          type:
          - string
          - 'null'
          description: A unique ID that identifies the tip only within this order.
          maxLength: 60
        applied_money:
          $ref: '#/components/schemas/Money'
          description: 'The amount of tip being returned

            --'
          readOnly: true
        source_tender_uid:
          type:
          - string
          - 'null'
          description: The tender `uid` from the order that contains the original application of this tip.
          maxLength: 192
        source_tender_id:
          type:
          - string
          - 'null'
          description: The tender `id` from the order that contains the original application of this tip.
          maxLength: 192
    PayOrderResponse:
      type: object
      description: 'Defines the fields that are included in the response body of a request to the

        [PayOrder](api-endpoint:Orders-PayOrder) endpoint.'
      x-release-status: BETA
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
        order:
          $ref: '#/components/schemas/Order'
          description: The paid, updated [order](entity:Order).
      example:
        order:
          closed_at: '2019-08-06T02:47:37.140Z'
          created_at: '2019-08-06T02:47:35.693Z'
          id: lgwOlEityYPJtcuvKTVKT1pA986YY
          line_items:
          - base_price_money:
              amount: 500
              currency: USD
            gross_sales_money:
              amount: 500
              currency: USD
            name: Item 1
            quantity: '1'
            total_discount_money:
              amount: 0
              currency: USD
            total_money:
              amount: 500
              currency: USD
            total_service_charge_money:
              amount: 0
              currency: USD
            total_tax_money:
              amount: 0
              currency: USD
            uid: QW6kofLHJK7JEKMjlSVP5C
          - base_price_money:
              amount: 750
              currency: USD
            gross_sales_money:
              amount: 1500
              currency: USD
            name: Item 2
            quantity: '2'
            total_discount_money:
              amount: 0
              currency: USD
            total_money:
              amount: 1500
              currency: USD
            total_service_charge_money:
              amount: 0
              currency: USD
            total_tax_money:
              amount: 0
              currency: USD
            uid: zhw8MNfRGdFQMI2WE1UBJD
          location_id: P3CCK6HSNDAS7
          net_amounts:
            discount_money:
              amount: 0
              currency: USD
            service_charge_money:
              amount: 0
              currency: USD
            tax_money:
              amount: 0
              currency: USD
            tip_money:
              amount: 0
              currency: USD
            total_money:
              amount: 2000
              currency: USD
          source:
            name: Source Name
          state: COMPLETED
          tenders:
          - amount_money:
              amount: 1000
              currency: USD
            card_details:
              card:
                card_brand: VISA
                exp_month: 2
                exp_year: 2022
                fingerprint: sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ
                last_4: '1111'
              entry_method: KEYED
              status: CAPTURED
            created_at: '2019-08-06T02:47:36.293Z'
            id: EnZdNAlWCmfh6Mt5FMNST1o7taB
            location_id: P3CCK6HSNDAS7
            payment_id: EnZdNAlWCmfh6Mt5FMNST1o7taB
            transaction_id: lgwOlEityYPJtcuvKTVKT1pA986YY
            type: CARD
          - amount_money:
              amount: 1000
              currency: USD
            card_details:
              card:
                card_brand: VISA
                exp_month: 2
                exp_year: 2022
                fingerprint: sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ
                last_4: '1111'
              entry_method: KEYED
              status: CAPTURED
            created_at: '2019-08-06T02:47:36.809Z'
            id: 0LRiVlbXVwe8ozu4KbZxd12mvaB
            location_id: P3CCK6HSNDAS7
            payment_id: 0LRiVlbXVwe8ozu4KbZxd12mvaB
            transaction_id: lgwOlEityYPJtcuvKTVKT1pA986YY
            type: CARD
          total_discount_money:
            amount: 0
            currency: USD
          total_money:
            amount: 2000
            currency: USD
          total_service_charge_money:
            amount: 0
            currency: USD
          total_tax_money:
            amount: 0
            currency: USD
          updated_at: '2019-08-06T02:47:37.140Z'
          version: 4
    RetrieveOrderResponse:
      type: object
      x-release-status: PUBLIC
      properties:
        order:
          $ref: '#/components/schemas/Order'
          description: The requested order.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
      example:
        order:
          created_at: '2020-05-18T16:30:49.614Z'
          discounts:
          - applied_money:
              amount: 550
              currency: USD
            name: 50% Off
            percentage: '50'
            scope: ORDER
            type: FIXED_PERCENTAGE
            uid: zGsRZP69aqSSR9lq9euSPB
          id: CAISENgvlJ6jLWAzERDzjyHVybY
          line_items:
          - applied_discounts:
            - applied_money:
                amount: 250
                currency: USD
              discount_uid: zGsRZP69aqSSR9lq9euSPB
              uid: 9zr9S4dxvPAixvn0lpa1VC
            base_price_money:
              amount: 500
             

# --- truncated at 32 KB (283 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-orders-api-openapi.yml