V1UpdateOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-v1-update-order-request-schema.json",
  "title": "V1UpdateOrderRequest",
  "description": "V1UpdateOrderRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/square-v1transactions-api-openapi.yml#/components/schemas/V1UpdateOrderRequest",
  "type": "object",
  "x-release-status": "DEPRECATED",
  "x-visibility": "SDK_ONLY",
  "required": [
    "action"
  ],
  "properties": {
    "action": {
      "$ref": "#/$defs/V1UpdateOrderRequestAction",
      "description": "The action to perform on the order (COMPLETE, CANCEL, or REFUND).\nSee [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values"
    },
    "shipped_tracking_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The tracking number of the shipment associated with the order. Only valid if action is COMPLETE."
    },
    "completed_note": {
      "type": [
        "string",
        "null"
      ],
      "description": "A merchant-specified note about the completion of the order. Only valid if action is COMPLETE."
    },
    "refunded_note": {
      "type": [
        "string",
        "null"
      ],
      "description": "A merchant-specified note about the refunding of the order. Only valid if action is REFUND."
    },
    "canceled_note": {
      "type": [
        "string",
        "null"
      ],
      "description": "A merchant-specified note about the canceling of the order. Only valid if action is CANCEL."
    }
  },
  "$defs": {
    "V1UpdateOrderRequestAction": {
      "type": "string",
      "enum": [
        "COMPLETE",
        "CANCEL",
        "REFUND"
      ],
      "x-enum-elements": [
        {
          "name": "COMPLETE",
          "description": ""
        },
        {
          "name": "CANCEL",
          "description": ""
        },
        {
          "name": "REFUND",
          "description": ""
        }
      ],
      "x-release-status": "DEPRECATED",
      "x-visibility": "SDK_ONLY"
    }
  }
}