File Manager

📁 Media Files

📁 .. (Parent Directory) 📁 bookings/ 📁 cashDrawers/ 📁 catalog/ 📁 checkout/ 📁 customers/ 📁 devices/ 📁 disputes/ 📁 giftCards/ 📁 labor/ 📁 locations/ 📁 loyalty/ 📁 merchants/ 📁 orders/ 📁 teamMembers/ 📁 terminal/ 📁 webhooks/ 📋 .htaccess 📋 __package__.yml 📋 api.yml 📋 applePay.yml 📋 bankAccounts.yml 📋 bookings.yml 📋 cards.yml 📋 catalog.yml 📋 checkout.yml 📋 customers.yml 📋 devices.yml 📋 disputes.yml 📋 employees.yml 📋 events.yml 📋 giftCards.yml 📋 inventory.yml 📋 invoices.yml 📋 locations.yml 📋 loyalty.yml 📋 merchants.yml 📋 mobile.yml 📋 oAuth.yml 📋 orders.yml 📋 payments.yml 📋 payouts.yml 📋 refunds.yml 📋 sites.yml 📋 snippets.yml 📋 subscriptions.yml 📋 team.yml 📋 teamMembers.yml 📋 terminal.yml 📋 v1Transactions.yml 📋 vendors.yml

⬆️ Upload Files

📁 Create Folder

📄 Create File

💻 Terminal

📦 Extract Archive

📋 Edit: v1Transactions.yml

YML

Size: 13.24 KB | Modified: 2026-01-02 07:46:36

imports:
  root: __package__.yml
service:
  auth: false
  base-path: ''
  endpoints:
    V1ListOrders:
      path: /v1/{location_id}/orders
      method: GET
      auth: true
      docs: Provides summary information for a merchant's online store orders.
      source:
        openapi: openapi/openapi.json
      display-name: V1ListOrders
      request:
        name: V1ListOrdersRequest
        path-parameters:
          location_id:
            type: string
            docs: The ID of the location to list online store orders for.
        query-parameters:
          order:
            type: optional<nullable<root.SortOrder>>
            docs: The order in which payments are listed in the response.
          limit:
            type: optional<nullable<integer>>
            docs: >-
              The maximum number of payments to return in a single response.
              This value cannot exceed 200.
          batch_token:
            type: optional<nullable<string>>
            docs: |-
              A pagination cursor to retrieve the next set of results for your
              original query to the endpoint.
      response:
        docs: Success
        type: list<root.V1Order>
        status-code: 200
      availability: deprecated
      examples:
        - path-parameters:
            location_id: location_id
          response:
            body:
              - errors:
                  - category: API_ERROR
                    code: INTERNAL_SERVER_ERROR
                id: id
                buyer_email: buyer_email
                recipient_name: recipient_name
                recipient_phone_number: recipient_phone_number
                state: PENDING
                shipping_address:
                  address_line_1: address_line_1
                  address_line_2: address_line_2
                  address_line_3: address_line_3
                  locality: locality
                  sublocality: sublocality
                  sublocality_2: sublocality_2
                  sublocality_3: sublocality_3
                  administrative_district_level_1: administrative_district_level_1
                  administrative_district_level_2: administrative_district_level_2
                  administrative_district_level_3: administrative_district_level_3
                  postal_code: postal_code
                  country: ZZ
                  first_name: first_name
                  last_name: last_name
                subtotal_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                total_shipping_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                total_tax_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                total_price_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                total_discount_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                created_at: created_at
                updated_at: updated_at
                expires_at: expires_at
                payment_id: payment_id
                buyer_note: buyer_note
                completed_note: completed_note
                refunded_note: refunded_note
                canceled_note: canceled_note
                tender:
                  id: id
                  type: CREDIT_CARD
                  name: name
                  employee_id: employee_id
                  receipt_url: receipt_url
                  card_brand: OTHER_BRAND
                  pan_suffix: pan_suffix
                  entry_method: MANUAL
                  payment_note: payment_note
                  tendered_at: tendered_at
                  settled_at: settled_at
                  is_exchange: true
                order_history:
                  - {}
                promo_code: promo_code
                btc_receive_address: btc_receive_address
                btc_price_satoshi: 1.1
    V1RetrieveOrder:
      path: /v1/{location_id}/orders/{order_id}
      method: GET
      auth: true
      docs: >-
        Provides comprehensive information for a single online store order,
        including the order's history.
      source:
        openapi: openapi/openapi.json
      display-name: V1RetrieveOrder
      request:
        name: V1RetrieveOrderRequest
        path-parameters:
          location_id:
            type: string
            docs: The ID of the order's associated location.
          order_id:
            type: string
            docs: >-
              The order's Square-issued ID. You obtain this value from Order
              objects returned by the List Orders endpoint
      response:
        docs: Success
        type: root.V1Order
        status-code: 200
      availability: deprecated
      examples:
        - path-parameters:
            location_id: location_id
            order_id: order_id
          response:
            body:
              errors:
                - category: API_ERROR
                  code: INTERNAL_SERVER_ERROR
                  detail: detail
                  field: field
              id: id
              buyer_email: buyer_email
              recipient_name: recipient_name
              recipient_phone_number: recipient_phone_number
              state: PENDING
              shipping_address:
                address_line_1: address_line_1
                address_line_2: address_line_2
                address_line_3: address_line_3
                locality: locality
                sublocality: sublocality
                sublocality_2: sublocality_2
                sublocality_3: sublocality_3
                administrative_district_level_1: administrative_district_level_1
                administrative_district_level_2: administrative_district_level_2
                administrative_district_level_3: administrative_district_level_3
                postal_code: postal_code
                country: ZZ
                first_name: first_name
                last_name: last_name
              subtotal_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_shipping_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_tax_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_price_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_discount_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              created_at: created_at
              updated_at: updated_at
              expires_at: expires_at
              payment_id: payment_id
              buyer_note: buyer_note
              completed_note: completed_note
              refunded_note: refunded_note
              canceled_note: canceled_note
              tender:
                id: id
                type: CREDIT_CARD
                name: name
                employee_id: employee_id
                receipt_url: receipt_url
                card_brand: OTHER_BRAND
                pan_suffix: pan_suffix
                entry_method: MANUAL
                payment_note: payment_note
                total_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                tendered_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                tendered_at: tendered_at
                settled_at: settled_at
                change_back_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                refunded_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                is_exchange: true
              order_history:
                - action: ORDER_PLACED
                  created_at: created_at
              promo_code: promo_code
              btc_receive_address: btc_receive_address
              btc_price_satoshi: 1.1
    V1UpdateOrder:
      path: /v1/{location_id}/orders/{order_id}
      method: PUT
      auth: true
      docs: >-
        Updates the details of an online store order. Every update you perform
        on an order corresponds to one of three actions:
      source:
        openapi: openapi/openapi.json
      display-name: V1UpdateOrder
      request:
        name: V1UpdateOrderRequest
        path-parameters:
          location_id:
            type: string
            docs: The ID of the order's associated location.
          order_id:
            type: string
            docs: >-
              The order's Square-issued ID. You obtain this value from Order
              objects returned by the List Orders endpoint
        body:
          properties:
            action:
              type: root.V1UpdateOrderRequestAction
              docs: >-
                The action to perform on the order (COMPLETE, CANCEL, or
                REFUND).

See
                [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction)
                for possible values
            shipped_tracking_number:
              type: optional<nullable<string>>
              docs: >-
                The tracking number of the shipment associated with the order.
                Only valid if action is COMPLETE.
            completed_note:
              type: optional<nullable<string>>
              docs: >-
                A merchant-specified note about the completion of the order.
                Only valid if action is COMPLETE.
            refunded_note:
              type: optional<nullable<string>>
              docs: >-
                A merchant-specified note about the refunding of the order. Only
                valid if action is REFUND.
            canceled_note:
              type: optional<nullable<string>>
              docs: >-
                A merchant-specified note about the canceling of the order. Only
                valid if action is CANCEL.
        content-type: application/json
      response:
        docs: Success
        type: root.V1Order
        status-code: 200
      availability: deprecated
      examples:
        - path-parameters:
            location_id: location_id
            order_id: order_id
          request:
            action: COMPLETE
          response:
            body:
              errors:
                - category: API_ERROR
                  code: INTERNAL_SERVER_ERROR
                  detail: detail
                  field: field
              id: id
              buyer_email: buyer_email
              recipient_name: recipient_name
              recipient_phone_number: recipient_phone_number
              state: PENDING
              shipping_address:
                address_line_1: address_line_1
                address_line_2: address_line_2
                address_line_3: address_line_3
                locality: locality
                sublocality: sublocality
                sublocality_2: sublocality_2
                sublocality_3: sublocality_3
                administrative_district_level_1: administrative_district_level_1
                administrative_district_level_2: administrative_district_level_2
                administrative_district_level_3: administrative_district_level_3
                postal_code: postal_code
                country: ZZ
                first_name: first_name
                last_name: last_name
              subtotal_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_shipping_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_tax_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_price_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              total_discount_money:
                amount: 1
                currency_code: UNKNOWN_CURRENCY
              created_at: created_at
              updated_at: updated_at
              expires_at: expires_at
              payment_id: payment_id
              buyer_note: buyer_note
              completed_note: completed_note
              refunded_note: refunded_note
              canceled_note: canceled_note
              tender:
                id: id
                type: CREDIT_CARD
                name: name
                employee_id: employee_id
                receipt_url: receipt_url
                card_brand: OTHER_BRAND
                pan_suffix: pan_suffix
                entry_method: MANUAL
                payment_note: payment_note
                total_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                tendered_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                tendered_at: tendered_at
                settled_at: settled_at
                change_back_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                refunded_money:
                  amount: 1
                  currency_code: UNKNOWN_CURRENCY
                is_exchange: true
              order_history:
                - action: ORDER_PLACED
                  created_at: created_at
              promo_code: promo_code
              btc_receive_address: btc_receive_address
              btc_price_satoshi: 1.1
  source:
    openapi: openapi/openapi.json

Supports: PHP, ASPX, HTML, JavaScript, CSS and other text-based files

📥 Download

File manager